文档即产品
最近更新
日期作者头像插件
新一代用于显示文档确切创建日期、最后更新日期、作者、头像、邮箱等信息的 MkDocs 插件 特性 - 始终显示文档的精确元信息,且适用于任何环境(无 Git、Git 环境、Docker 容器、所有 CI/CD 构建系统等) - 支持列表显示最近更新的文档(按更新日期降序排列) - 支持在 Front Matter 中手动指定日期和作者 - 支持多种日期格式(date、datetime、timeago) - 支持多种作者模式(头像、文本、隐藏) - 支持手动配置作者的姓名、链接、头像、邮箱等 - 灵活的显示位置(顶部或底部) - 优雅的样式设计(完全可定制)
下一代主题插件 MaterialX
MaterialX for MkDocs,下一代 mkdocs-material,基于 mkdocs-material-9.7.1 衍生,取名为 X,会持续提供维护与更新。 由于 mkdocs-material 已进入维护模式,不再有新功能,而替代品 Zensical 目前还不完善,并且不兼容 MkDocs 原有的插件生态,这将导致原本的繁荣生态被打破而失去活力,用户原本稳定而又完善的站点如果要迁移到 Zensical,则有着较高的迁移成本和不稳定性的风险。 那有没有办法做到,既能拥有 mkdocs-material 的丰富生态和稳定性,又能拥有像 Zensical 一样的新特性呢? 答案就是 MaterialX,并且 MaterialX 将有着以下全新的定位。 MaterialX 路线图 在我看来,技术的魅力在于让更多的人利用你提供的工具轻而易举就实现了他原来很难做到的事。 一个好的产品,在功能设计上,应该是恰到好处,适可而止,而不是提供更多的功能选择和眼花缭乱的配置项。说实话,无论是 mkdocs-material 还是 Zensical,都有点个性化过度了,配置项太多太复杂了,谁的配置项最后不是动辄几百行?哪个初次用 mkdocs-material 的人没折腾上好几天? 而我希望把它做成一个傻瓜式的程序,用户只需要简单少量的配置,就能轻松把平时的笔记和文档转成自己的专业站点,方便传播分享与交流。 所以,MaterialX 将遵循以下目标和原则: - 目标:追求人人可用,人人都可拥有自己的网站,包括但不限于开发者、产品经理、运营人员、运维人员等,不再是技术人员的专利
最近更新列表插件
mkdocs-recently-updated-docs:一行代码显示最近更新的文档列表 - 按更新时间降序显示最近更新的文档,列表项动态更新 - 支持列表、详情、网格等多种视图模式 - 支持自动提取文章摘要 - 支持在 Front Matter 中自定义文章封面 - 支持自定义显示数量 - 支持排除指定文件或目录 - 适用于任何环境(no-Git, Git, Docker, all CI/CD build systems, etc.)
Markdown 实用语法
一、什么是 Markdown Markdown 是一种轻量级的纯文本标记语言,用简单少量的符号对文字进行标注,从而实现以最小的输入代价生成印刷级排版格式的文档。它在流畅的书写和印刷级阅读体验之间找到了平衡,让人只需专注内容而不是纠结排版。 常用的标记符号 不超过十个,好记好用好效果。(非程序员用户如产品、运营 ... 也可以轻松搞定) 二、Markdown 编辑器 - Typora(Mac、Win、Linux),简约不简单,所见即所得;✓ - MWeb(Mac、iOS),一款专注于 Markdown 的写作、记笔记和发布软件; - Obsidian(Mac、Win、Linux、iOS、Android),一款支持 Zettelkasten 笔记法的笔记管理软件,利用「双向链接」打造「知识循环」体系,支持基础的 markdown 语法; - YankNote(Mac、Win、Linux),一款强大可扩展的 Markdown 编辑器,满足了所有幻想,还可以在线体验;✓ - mdx-notes(Mac、Win、Linux、Web),跨平台笔记软件,Web版 在线编辑器可作为网文排版工具; - markdown-online-editor,Arya - 在线 Markdown 编辑器,支持所有基础语法、数学公式、Mermaid 图表、Echarts 图表、五线谱,以及 PPT 模式、视频音频解析等;✓
海南
一、定目的地 - 三亚:市中心、三亚湾、大东海、亚龙湾、海棠湾; - 陵水:土福湾、清水湾、日月湾(冲浪)、石梅湾(观海亭+最美公路); - 海口:看小红书笔记分享(看个十条八条); 二、出行方式 飞海口 - 先飞海口,再坐高铁到旅游目的地。海口机场隔壁就是美兰高铁站,可直达三亚、陵水等,海南省的高铁是一个绕岛循环线路,来回转圈,发车多,比较方便和经济,还能欣赏一下沿途风景。 飞三亚 - 直飞三亚,再打车到目的地。旅游旺季机票相对较贵,而且从机场打车到目的地也得个把小时,整体花费多也没省时间。 三、住宿与出行
Aaron 极简风主题
- 基于 MaterialX for MkDocs 优化和美化,内置 Zensical 一样的现代主题
- 包含主题配色切换功能,支持自适应系统主题配色
- 包含多语言选择功能,支持自适应本地化语言
- 内置新一代日期作者头像插件 mkdocs-document-dates
- 内置 GLightbox 插件,支持图像灯箱特效
- 内置 AI i18n 多语言插件,支持 100+ 语言自由切换
- 内置离线插件,可离线访问网站
- 内置搜索插件、博客插件
- 支持数理公式、化学方程式渲染
- 支持 mermaid 绘图渲染
- 清爽简洁、小白易用
笔记文档的终极解决方案
笔记工具也好,文档平台也好,不是功能越多越炫丽越好,而是应该大道至简,追求极简易用,人人可用,追求以下目标和原则:
目标:
- 最小的输入代价
- 印刷级阅读体验
- 随处的排版发布
- 丰富的格式转换
- 导出迁移无限制
- 安全存储无广告
- 简洁易用无门槛
- 我的内容我做主
原则:Write Once, Show Anywhere,一次编写,随处展示,在任意地方以任意格式精美的展示内容。
方案:而实现这样的目标原则,最佳方式就是:采用「Markdown 格式 + 专业工具本地编写」
- 专业编写:你可以使用任意你喜欢的专业 Markdown 编辑器编写内容,无任何限制且支持全部 Markdown 语法
- 通用格式:支持一键导出 PDF、Word、Image、HTML、ePub,一键生成 PPT 幻灯片、思维导图、静态网站
- 任意发布:支持一键排版到 微信公众号、知乎、掘金、头条、Github、各类知识库 等平台
- 安全无患:内容存在本地,不受任何平台限制,使用无门槛,安全无广告,我的内容我做主
这样,你就只需要专注于自己的内容,无需关心格式、排版,无需担心某些平台有什么限制 ...
以上所有技巧见:hongjun.vip/
交流群¶
Discord: https://discord.gg/cvTfge4AUy
Wechat:
