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 // 主要的配置文件

...

 http://www.javashuo.com/article/p-etehfnll-cc.html