mkdocs-material 静态生成器 简易安装教程

mkdocs-material 静态生成器 简易安装教程

https://squidfunk.github.io/mkdocs-material/getting-started/

这个算是python里面最好的 静态生成器了

安装教程

1. 已经有py3的运行环境
2. 创建一个目录 study-mkdocs
3. 进入目录后 创建虚拟环境 python -m venv venv-mkdocs
4. 进入虚拟环境 venv-mkdocs\Scripts\activate
5. 安装mkdocs pip install mkdocs-material
6. 创建笔记文件 mkdocs new .
7. 将mkdocs.yml 内容修改为

# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
site_name: My Docs
site_url: https://mydomain.org/mysite
theme:
  name: material
  palette:
    scheme: slate
    primary: black

8. 安装vscode插件 yaml，在setting.json 中添加

"yaml.schemas": {
    "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
  },
  "yaml.customTags": [ 
    "!ENV scalar",
    "!ENV sequence",
    "!relative scalar",
    "tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg",
    "tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji",
    "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format",
    "tag:yaml.org,2002:python/object/apply:pymdownx.slugs.slugify mapping"
  ]

9. 启动命令 mkdocs serve
10. 打包命令 mkdocs build

中文搜索问题

这个默认没有中文搜索，如果正式用的话，需要安装 中文搜索插件。