关于

完整文档

• 官网: https://www.mkdocs.org
• Material for MkDocs: https://squidfunk.github.io/mkdocs-material/

基本命令

1. mkdocs new [dir-name] - 在指定文件夹初始化文档
2. mkdocs serve - 启动本地服务实时预览
3. mkdocs build - 编译静态文件
4. mkdocs -h - 帮助信息

文件布局

mkdocs.yml    # 配置文件
docs/
    index.md  # 文档主页
    ...       # 其他页

Material for MkDocs

Material for MkDocs是mkdocs的一款极为优秀的主题。