跳转至

最近更新

下一代主题插件 MaterialX
下一代主题插件 MaterialX
MaterialX for MkDocs，下一代 mkdocs-material，让你继续用熟悉的方式构建漂亮站点。基于 mkdocs-material-9.7.1 衍生，取名为 X，提供持续的维护与更新。 由于 MkDocs 原作者的个人问题，MkDocs 项目即将走向尽头。他已停止更新 MkDocs，并打算发布一个全新的 2.0 版本作为替代。可是，这个新版本与现有生态系统完全不兼容，它是一个完全独立的项目，只是沿用了 MkDocs 这个名称，一旦你不小心升级了，将导致毁灭性的破坏。 所以，为了摆脱对 MkDocs 的依赖，原流行主题框架 mkdocs-material 团队停止了对 mkdocs-material 的维护，转而去开发了一个全新的同类项目 Zensical，优点是现代架构，缺点是不兼容原来的 MkDocs 生态（无插件），有着较高的迁移成本（所有配置项都需要从头重建），且目前很多基础功能还不完善。 为了让原有的 MkDocs 生态和项目持续且稳定的运行下去，MkDocs 有了新的社区继任者 ProperDocs (基于 MkDocs 1.6.1)，会提供持续的更新维护且无缝兼容原来的 MkDocs 生态。 同样 mkdocs-material 也迎来了新的继任者 MaterialX (基于 mkdocs-material 9.7.1)，也会提供持续的更新维护，且无缝兼容原有的生态，零迁移成本。 MaterialX 既维持了 mkdocs-material 项目的 丰富功能 和 稳定性，又拥有了 新特性 和 兼容性，并将拥有以下全新愿景和定位。 MaterialX 路线图 MaterialX 旨在成为 极简易用傻瓜式 的静态站点生成器，用户只需要简单且少量的配置，就能轻松把平时的笔记和文档转成专业站点，方便传播分享与交流。 在我看来，技术的魅力在于让更多的人利用你提供的工具轻而易举就实现了他原来很难做到的事。 一个好的产品，在功能设计上，应该是恰到好处，适可而止，而不是提供更多的功能选择和眼花缭乱的配置项。说实话，无论是 mkdocs-material 还是 Zensical，都有点个性化过度了，配置项太多太复杂了，谁的配置项最后不是动辄几百行？哪个初次用 mkdocs-material 的人没折腾上好几天？
hourglass_top阅读时长 10 分钟
日期作者头像插件(英)
mkdocs-document-dates, a new generation MkDocs / ProperDocs plugin for displaying exact creation date, last updated date, authors, email of documents. Features - Works in any environment (no-Git, Git environments, Docker, all CI/CD build systems, etc.) - Support list display of recently updated documents (in descending order of update date) - Support for manually specifying date and author in Front Matter - Support for multiple date formats (date, datetime, timeago) - Support for multiple author modes (avatar, text, hidden) - Support for manually configuring author's name, link, avatar, email, etc. - Flexible display position (top or bottom) - Elegant styling (fully customizable)
hourglass_top阅读时长 12 分钟
日期作者头像插件(中)
mkdocs-document-dates，新一代用于显示文档确切创建日期、最后更新日期、作者、头像、邮箱等信息的 MkDocs / ProperDocs 插件 特性 - 适用于任何环境：无 Git、Git 环境、Docker 容器、所有 CI/CD 构建系统等 - 支持列表显示最近更新的文档（按更新日期倒序排列） - 支持在 Front Matter 中手动指定日期和作者 - 支持多种日期格式（date、datetime、timeago） - 支持多种作者模式（头像、文本、隐藏） - 支持手动配置作者的姓名、链接、头像、邮箱等 - 灵活的显示位置（顶部或底部） - 优雅的样式设计（完全可定制）
hourglass_top阅读时长 10 分钟
Markdown 实用技巧
一、什么是 Markdown Markdown 是一种轻量级的纯文本标记语言，用简单少量的符号对文字进行标注，从而实现 以最小的输入代价生成印刷级排版格式的文档。它在 流畅的书写 和 印刷级阅读体验 之间找到了平衡，让人只需专注内容而不是纠结排版。 常用的标记符号 不超过十个，好记好用好效果。(非程序员用户如产品、运营、运维 ... 也可以轻松搞定) 二、Markdown 编辑器 - Typora（Mac、Win、Linux），简约不简单，所见即所得；✓ - MWeb（Mac、iOS），一款专注于 Markdown 的写作、记笔记和发布软件； - Obsidian（Mac、Win、Linux、iOS、Android），一款支持 Zettelkasten 笔记法的笔记管理软件，非专业 Markdown 编辑器，只支持基础的 markdown 语法； - YankNote（Mac、Win、Linux），一款强大可扩展的 Markdown 编辑器，满足了所有幻想，还可以在线体验；✓ - mdx-notes（Mac、Win、Linux、Web），跨平台笔记软件，Web版 在线编辑器可作为网文排版工具； - markdown-online-editor，Arya - 在线 Markdown 编辑器，支持所有基础语法、数学公式、Mermaid 图表、Echarts 图表、五线谱，以及 PPT 模式、视频音频解析等；✓
hourglass_top阅读时长 9 分钟
tutorial markdown
全链路无人值守自动化 SSL
起因 腾讯云的免费 SSL 证书有效期只有 3 个月，且不支持自动续签，不是很方便（其他云厂商也类似） 解决方案 - [ ] A：每三个月手动更新一次（免费 + 手动续签 + 手动上传） - [x] B：使用 Let's Encrypt + acme.sh / Certbot 脚本（免费 + 自动续签 + 自动上传） - [ ] C：购买付费证书（付费 + 自动续签 + 无需上传） 选 B（土豪随意） 结合 acme.sh[^acme] + GitHub Actions，撸了一套 全链路无人值守自动化 SSL 脚本，具备以下特色： 脚本流程指令 脚本下载
hourglass_top阅读时长 3 分钟
效率 CI
友情链接
如何交换友链 步骤： 1. 为自己的站点添加友链功能 2. 添加本站友链 3. 加入友链到本站（在下方留言申请） 期望您的站点： - 独立博客(不要求独立域名)，访问流畅 - 原创内容为主，原创内容5篇以上 - 处于活跃状态，有一定的更新频率 - 建站一个月以上
hourglass_top阅读时长 3 分钟
克隆此站
本站内容，全部是在本地使用 Markdown 编写，然后一键同步到各平台，你看到的此网站也是使用 MkDocs 一键生成的，非常方便。 如果你也想拥有这样一个简约而不简单的站点平台，可直接拷贝和应用我特意给大家提供的 此网站模板，以简化使用门槛。 特色 - 基于 MaterialX for MkDocs 优化和美化，内置 Zensical 一样的现代主题 - 包含主题配色切换功能，支持自适应系统主题配色 - 包含多语言选择功能，支持自适应本地化语言 - 内置新一代日期作者头像插件 mkdocs-document-dates - 内置 GLightbox 插件，支持图像灯箱特效 - 内置 AI i18n 多语言插件，支持 100+ 语言自由切换 - 内置离线插件，可离线访问网站
hourglass_top阅读时长 2 分钟
网站部署 - SEO 优化
之前把 网站部署到 Netlify（免费、配置简单、支持全球访问），服务器和域名都由 Netlify 提供，但这个结构无法稳定支持国内搜索引擎收录，所以再优化一下 优化目标 内容能被国内外主流搜索引擎抓取并收录 影响因子 收录影响因素（国内引擎）： 收录概率（国内引擎）： 方案设计 1）方案（境外服务器 + 境内CDN + 备案域名） 采用 最具性价比、维护最轻量 的方案（无需购买国内服务器、无需重新部署程序）： - 境外（原有）：源服务器（例如 Netlify） + Netlify 域名
hourglass_top阅读时长 7 分钟
Markdown 生成静态网站
可将 Markdown 笔记文档一键生成专业的静态网站，你不需要技术开发，也不需要懂开发。 工具对比 - Hugo：由 Go语言实现的静态网站生成器； - Jekyll：由 GitHub 联创创建的基于 Ruby 的静态站点生成器； - Hexo：一个快速、简洁的基于 Node.js 的博客框架； - VuePress：Vue 驱动的静态网站生成器； - VitePress：Vite 和 Vue 驱动的静态站点生成器，比 VuePress 更轻更快； - Docusaurus：基于 React 的静态网站生成器； - GitBook：一个使用 Git 和 Markdown 来构建书籍的工具； - MkDocs：一款流行的、基于 Python 的静态网站生成器；
hourglass_top阅读时长 7 分钟
最近更新列表插件
mkdocs-recently-updated-docs：一行代码显示最近更新的文档列表 - 按更新时间降序显示最近更新的文档，列表项动态更新 - 支持列表、详情、网格等多种视图模式 - 支持自动提取文章摘要 - 支持在 Front Matter 中自定义文章封面 - 支持自定义显示数量 - 支持排除指定文件或目录 - 适用于任何环境（no-Git, Git, Docker, all CI/CD build systems, etc.） 最新更新模块会以结构化的方式展示站点的文档信息，这非常适合文档数量众多或更新频繁的网站，这样读者可以快速查看最新内容
hourglass_top阅读时长 1 分钟

精选推荐

一劳永逸

其实，平时没有写作习惯，只不过有时候工作需要或记忆需要，总是要写点诸如文档笔记、思路灵感、幻灯片、思维导图、汇报总结 ... 啥的，随着文件的积攒，就想，那就系统化的整理和归纳一下吧，也方便形成自己的知识库。常规的办公软件、笔记工具、写作平台用起来很费劲，要么复杂，要么难用，要么限制多 ... 总之，要做一份不难看的文档，需要花费大量时间去调那些无关紧要的格式、样式与限制，使用体验那就是五个字：从入门到放弃。

于是，便有了此念头「Write Once, Show Anywhere」，你没看错，就是「一次编写，随处展示」，在任意地方以任意格式精美的展示。

而实现这样的目标的最佳方式就是：采用「Markdown 格式 + 专业工具本地编写」
( 细节可参考：笔记文档一把梭 )

  • 本地编写：你可以使用任意你喜欢的专业 Markdown 编辑器编写内容，无任何限制且支持全部的 Markdown 语法；
  • 通用格式：支持一键导出 PDF、Word、Image、HTML、ePub，也支持一键生成 PPT 幻灯片、思维导图、静态网站（比如此网站）；
  • 任意发布：支持一键排版到 微信公众号、知乎、掘金、头条、Github、各类知识库 等平台；
  • 安全无患：内容存在本地，不受任何平台限制，使用无门槛，安全无广告，我的内容我做主；

这样，你就只需要专注于自己的内容，无需关心格式、排版，无需担心某些平台有什么限制 ...

( 以上所有技巧见上方精选推荐 )

克隆此站

本站内容，全部是在本地使用 Markdown 编写，然后一键同步到各平台，你看到的此网站也是使用 MkDocs 一键生成的，非常方便。如果你也想拥有这样一个简约而不简单的站点平台，可直接拷贝和应用我特意给大家提供的 此网站模板，以简化使用门槛。