MkDocs搭建

本地环境搭建

# 配置python 环境
rm -rf venv
python3 -m venv venv
source '/venv/bin/activate'
deactivate
# 环境安装
pip install mkdocs mkdocs-material
# 查看版本
mkdocs --version
# 新建项目
mkdocs new wiki-mkdocs
# 运行项目
cd wiki-mkdocs
mkdocs serve
# Run on port 80, accessible over the local network.
# 默认值: '127.0.0.1:8000'
mkdocs serve --dev-addr=0.0.0.0:80 
mkdocs serve --dev-addr=127.0.0.1:9988
# 站点生成
mkdocs build
# 如果相关的文档仍残留在 site 目录中. 可在构建命令中添加 --clean 参数即可移除这些文档.
mkdocs build --clean
# 更新mkdocs版本
pip install -U mkdocs

#命令行使用mkdocs，可以加上 python -m
python -m mkdocs build --clean
python -m mkdocs serve --dev-addr=127.0.0.1:9988

新建完项目，有一个配置文件 mkdocs.yml, 和一个包含文档源码的 docs 文件夹. 在docs文件夹里包含了一个名为 index.md 的文档，在站点生成后，源码被分别输出为 index.html 和 about/index.html. 主题中的其他文件也被复制到了 site 目录中。

发布

MkDocs 生成的文档只包含静态文件, 因此你可以将文档部署到任意地方，只需上传 site 目录到你需要发布的位置即可.

插件

# 支持待办清单
pip install markdown-checklist

markdown_extensions:
  - markdown_checklist.extension

# 加密
pip install mkdocs-encryptcontent-plugin

# 图片
pip install mkdocs-mermaid2-plugin

# 圖片展示
python -m pip install mkdocs-glightbox

plugins:
  - glightbox

# 支持在 Markdown 中使用变量和简单逻辑，增强文档的可维护性
pip install mkdocs-macros-plugin
plugins:
  - macros

# 实现自定义目录排序和分组，增强导航体验 
pip install mkdocs-awesome-pages-plugin
# 构建时自动压缩 HTML 页面，提高加载速度
pip install mkdocs-minify-plugin
# 支持在文档中集成博客模式
pip install mkdocs-blog-plugin

plugins:
  - awesome-pages
  - minify
  - blog