Mkdocs

本站点使用Mkdocs进行部署，详细的文档请参考mkdocs.org

命令

  • 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.

项目结构

doc目录中为文章所在目录，其中Custom可以存放自定义配置 mkdoc.yml为主配置项，此处使用了mkdocs-material主题

Project Layout
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
.
├── Dockerfile
├── docker-compose.yml # Docker deploying file
├── docs
│   ├── custom # Custom configuration files
│   ├── index.md # The documentation homepage
│   └── ... # Other markdown pages, images and other files
├── mkdocs.yml # The configuration file
├── overrides # The theme custom configuration files
└── .gitignore

评论