MKDocs 使用

仅以此文介绍如何使用MKDocs,官网

1. 安装MKDocs

1. 安装Python
2. pip 安装
   $ pip install mkdocs
3. 检查是否安装成功
   $ mkdocs --version

2. 使用MKDocs

1. 创建工程
  $ mkdocs new my-project
  $ cd my-project
2. 开启本地服务器
  $ mkdocs serve

image.png

3. 在浏览器中打开默认页面 http://127.0.0.1:8000/

4. 新增一个页面
    可以自己手动写一个md文件放在docs目录下,并在配置文件中按照下面格式进行配置.
配置完会自动编译,若没有编译,则需手动编译
   $ mkdocs build

image.png