MkDocs

• mkdocs
• mkdocs-material
• https://zhuanlan.zhihu.com/p/383582472

  是一个用于创建项目文档的快速, 简单, 完美华丽的静态站点生成器. 文档源码使用Markdown 来撰写, 用一个YAML 文件作为配置文档

1 基础命令

For full documentation visit mkdocs.org.

1.1 Commands

• mkdocs new [dir-name] - Create a new project.
• mkdocs serve - Start the live-reloading docs server.
• mkdocs build - Build the documentation site.
• mkdocs -h - Print help message and exit.

1.2 Project layout

mkdocs.yml    ## The configuration file.
docs/
    index.md  ## The documentation homepage.
    ...       ## Other markdown pages, images and other files.

2 mkdocs.yml 配置

2.1 site_name