GMEM's Home

• 安装mkdocs

  MkDocs 文档开发教程 (mkdocs-like-code.readthedocs.io)

  pip install mkdocs
  # Print help message
  mkdocs -h 

• 网页组成

  mkdocs.yml    # The configuration file.
  docs/
      index.md  # The documentation homepage.
      ...       # Other markdown pages, images and other files.
  site/
      index.html # 由mkdocs生成的静态网页，托管到gh-pages分支
      ... 

• 在本地查看网页

  mkdocs serve

• 更新网页到gh-pages分支

  mkdocs gh-deploy --force --no-history -f ./mkdocs.yml