MkDocs☍

约 76 个字 37 行代码预计阅读时间 4 分钟

参考

MkDocs安装☍

pip install mkdocs

常用指令☍

创建工作区启动服务构建静态文件部署到github查看帮助

mkdocs new <work-space-name>

mkdocs serve

mkdocs build

mkdocs gh-deploy

mkdocs -h

目录结构☍

    <work-space-name>
    ├── mkdocs.yml
    ├── site
    │   ├── ...
    │   └── ...
    ├── docs
    │   ├── ...
    │   │   ├── ...
    │   │   └── ...
    │   └── index.md
    └── README.md

配置文件☍

mkdocs.yml

site_name: <site-name>  # 网站名称
site_url: <site-url>    # 网站地址
site_description: <site-description>    # 网站描述
site_author: <site-author>  # 网站作者

repo_url: <repo-url>    # 仓库地址(1)
edit_uri: <edit-uri>    # 编辑地址(2)

theme: <theme-name> # 主题名称
markdown_extensions: # 扩展语法
    - ...
    - ...
extra_css: # 额外的css
    - ...
    - ...
extra_javascript: # 额外的js
    - ...
    - ...
plugins: # 插件
    - ...
    - ...
nav:    # 导航栏
    - <nav-name>: <nav-link>
    - <nav-name>: <nav-link>
    - <nav-name>: <nav-link>

用于部署到 github
用于编辑页面的编辑按钮