mkdocs-material使用方法

安装mkdocs-material

1. 下载安装python3
2. pip换源: pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple
3. 升级pip:  python -m pip install --upgrade pip
4. 安装mkdocs-material:  pip install mkdocs-material

使用方法

1. 创建test文档站点:  mkdocs new test

2. 进入test目录修改mkdocs.yml,设置主题为material:
site_name: My Docs
theme:
  name: material

3. 启动站点:  mkdocs serve
4. 访问站点:  http://127.0.0.1:8000/
5. 编译成静态html:  mkdocs build

参考

https://squidfunk.github.io/mkdocs-material/setup/
https://shafish.cn/blog/mkdocs/#__tabbed_8_2

你可能感兴趣的:(杂记,mkdocs)