mkdocs生成項目文檔

mkdocs是一個項目文檔生成器

文檔：

https://www.mkdocs.org/ 安裝

pip install mkdocs      

建立項目

mkdocs new my-project
cd my-project      

項目目錄

.
├── docs
│   └── index.md
├── mkdocs.yml      

運作服務

$ mkdocs serve      

http://127.0.0.1:8000/

文檔生成

mkdocs build
mkdocs build --clean      

部署到github

# 先推到master分支
echo "site/" >> .gitignore
git init
git add . 
git commit -m "add"
git push

# 再進行部署
mkdocs gh-deploy
      

一個不錯的主題

pip install mkdocs-material      

mkdocs.yml配置示例

site_name: 項目文檔

nav:
    - 首頁: index.md
    - 關于: about.md

theme:
  name: 'material'
  language: 'zh'

extra:
  social:
    - type: 'github'
      link: 'https://github.com/mouday'