mkdocs 使用说明

mkdocs 使用说明

---

安装

pip3 install mkdocs==1.4.2

创建项目

mkdocs new my-project
cd my-project

修改 mkdocs.yml

site_name: My Docs

site_url: https://example.com/

nav:
    - Home: index.md
    - 测试: 测试.md
    
theme: readthedocs

extra:
    version: 1.0

运行

mkdocs serve

访问

http://127.0.0.1:8000

支持中文搜索

• 修改搜索文件

D:\Python37\Lib\site-packages\mkdocs\contrib\search\search_index.py

• 替换 lunr.js

下载 https://raw.githubusercontent.com/codepiano/lunr.js/master/lunr.min.js 
重命名 为 lunr.js 覆盖
D:\Python37\Lib\site-packages\mkdocs\contrib\search\templates\search\lunr.js

具体说明参考

编译成静态文件

mkdocs build