MkDocs

MkDocs 是一个文档生成器，可以将 Markdown 文件转换为完整的静态 HTML 网站。您用 Markdown 编写内容，这是一种任何人都能在几分钟内学会的简单文本格式。然后，MkDocs 处理这些文件，创建一个带有导航、搜索和美观设计的完整网站。

该工具包含一个内置的开发服务器，可以在您输入时实时预览。这意味着您无需手动刷新浏览器即可立即看到更改。MkDocs 提供两个内置主题，并支持许多社区创建的主题，如流行的 Material for MkDocs。

由于 MkDocs 生成的是静态文件，您的文档加载速度快，且可以在任何地方托管，无需复杂的服务器设置或数据库。

开始使用 MkDocs 非常简单：

• 如果您的电脑尚未安装 Python，请先安装。MkDocs 需要 Python 3.8 或更高版本才能正常运行。

• 使用命令安装 MkDocs：pip install mkdocs。此操作会下载并设置所需的所有内容。

• 通过运行命令创建新项目：mkdocs new my-project。此命令会创建一个包含配置文件和示例文档的基本结构文件夹。

• 在 docs 文件夹内的 Markdown 文件中编写您的文档。每个文件都会成为网站上的一个页面。

• 通过运行命令预览您的工作：mkdocs serve。此命令会启动本地服务器，通常地址为 http://127.0.0.1:8000，您可以实时查看文档内容。

• 使用命令构建最终网站：mkdocs build。此命令会创建一个包含所有 HTML 文件的 site 文件夹，准备发布。

• 使用 mkdocs gh-deploy 将文档部署到 GitHub Pages，或将 site 文件夹内容上传到任何网页托管服务。

• 基于Markdown的文档编写

• 实时预览，自动刷新浏览器

• 内置及第三方主题支持

• 单一YAML配置文件

• 插件系统以扩展功能

• 生成快速的静态HTML网站

• 集成搜索，无需外部服务

• 可部署于任何平台（GitHub Pages、Netlify等）

• 开源且完全免费

• 活跃的社区支持与开发