mkdocs 生成帮助文档

简介

MkDocs 可以同时编译多个markdown文件，形成书籍一样的文件。有多种主题供你选择，很适合项目使用。

MkDocs 是快速，简单和华丽的静态网站生成器，可以构建项目文档。文档源文件在 Markdown 编写，使用单个 YAML 配置文件配置。

官方快速开始

https://squidfunk.github.io/mkdocs-material/getting-started/

 本人整理的快速开始

 

首先安装python 

// 安装
pip install mkdocs

// 安装后查看一下版本：

mkdocs  --version

// 初始化一个项目
mkdocs  new  myproject

cd  myproject

// 启动
mkdocs serve

// 升级
pip install -U mkdocs

// 卸载
pip uninstall mkdocs

  

中文帮助文档

https://markdown-docs-zh.readthedocs.io/zh_CN/latest/

源码

git clone https://github.com/squidfunk/mkdocs-material.git

启动

mkdocs serve

配置：mkdocs.yml

# Page tree
nav:
  - aaaaaa:
    - aaaaaa.1: aaaaaa.1.md
    - aaaaaa.2: aaaaaa.2.md
  - bbbbbb:
    - bbbbbb.1:
      - bbbbbb.1.1:
        - bbbbbb.1.1.1: bbbbbb.1.1.1.md
    - bbbbbb.2: bbbbbb.2.md
  - aaaaaa: aaaaaa.md
  - cccccc: cccccc.md

 

打包成静态到 /site 目录 

mkdocs build --clean

 

/doc   // markdown 文件，也是文章列表数据文件

/material // 主程序

/site  // 打包后的静态文件

mkdocs.yml // 主要的配置文件

...

 https://www.cnblogs.com/simonid/p/6354034.html

 

转载于:https://www.cnblogs.com/xiangsj/p/9869617.html