跳转至

博客声明

对于习惯了在 VSCode 中编写代码和配置各种工程环境的开发者来说,掌握 MkDocs 的核心流程(从安装到能在本地浏览器预览第一篇文章)只需要 30 分钟到 1 个小时

它本质上只是一个将 Markdown 转换为 HTML 的 Python 静态生成器,你完全没有必要把它当成一门新语言去“学习”,只需要把它当成一个普通的 Python 依赖库来“配置”。

以下是你在这短短几个小时内的具体时间分配预期:

1. 基础环境搭建:约 10 分钟

只需在你的终端里运行几个基础的 pip 命令即可安装 MkDocs 以及最主流的 Material 主题。 随后,通过一条 mkdocs new my-blog 命令,系统就会为你生成最基础的文件骨架。最后运行 mkdocs serve,你就能立刻在本地的 localhost:8000 看到你的博客雏形了。

2. 理解核心配置文件 (mkdocs.yml):约 30 分钟

这是你主要需要“学习”的地方。MkDocs 几乎所有的设置(从网站名字、顶部导航栏、左侧文章目录的层级关系,到页面底部的版权信息)都是通过修改项目根目录下的 mkdocs.yml 文件来实现的。 只要你熟悉 YAML 的缩进语法,这部分就像填空题一样简单。

3. 内容创作 (Markdown 写作):0 学习成本

把你平时记录工程踩坑记录、技术笔记或算法思路的 Markdown 文件,直接扔进项目生成的 docs/ 文件夹里即可。MkDocs 会自动将它们渲染成排版精美的网页。它原生地对代码块高亮和数学公式有着极好的支持。

4. 进阶定制与部署:半天到一天(按需进行)

如果你对默认样式不满足,或者想实现完全的自动化:

  • 调整主题细节: 比如开启深色/浅色模式切换按钮、更改主色调、添加全局搜索框,这需要查阅 Material for MkDocs 的官方文档,修改 mkdocs.yml 中的几行代码。
  • 自动化部署: 配置一次 GitHub Actions。只要照抄一段官方提供的 YAML 自动化脚本,就能实现“只要你在本地 git push 代码,云端就会自动帮你把新文章发布到网上”。配置好之后,这就成了一劳永逸的无感操作。

评论区