跳转至

欢迎来到 MkDocs

更详细的文档请参考 mkdocs.org.

命令

  • mkdocs new [dir-name] - 创建一个新的项目
  • mkdocs serve - 启动 server
  • mkdocs build - 生成静态页面
  • mkdocs -h - 输出 help message

项目构造

mkdocs.yml    # 配置文件
docs/
    index.md  # 首页
    ...       # 可放置其他 markdown 文档,图片等。