Skip to content

欢迎来到 MkDocs

有关完整文档,请访问 mkdocs.org.

命令

  • mkdocs new [dir-name] -创建一个新项目。
  • mkdocs serve - 启动实时重装文档服务器。
  • mkdocs build - 建立文档网站。
  • mkdocs -h - 打印帮助消息并退出。

项目布局

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