pip install mkdocs

mkdocs new my-project
cd my-project

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

$ mkdocs serve

mkdocs build
mkdocs build --clean

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

# 再进行部署
mkdocs gh-deploy

pip install mkdocs-material

site_name: 项目文档

nav:
    - 主页: index.md
    - 关于: about.md

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

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