Files
FastapiAdmin/mkdocs/docs/doc/mkdocs.md
T
2024-12-10 17:39:26 +08:00

822 B
Executable File

Markdown转静态网站(mkdocs-material使用)

工具介绍

工具安装

pip install mkdocs-material

工具使用

创建项目

mkdocs new my_docs

编辑构建文档

theme:
  name: material

启动服务

mkdocs serve

构建静态站点

mkdocs build

获取帮助

mkdocs -h

生成所有依赖

pip freeze > requirements.txt
mkdocs
mkdocs-include-markdown-plugin
mkdocs-material #  安装主题
mkdocs-material-extensions
mkdocs-pdf-export-plugin
mkdocs-minify-plugin # 插件
mkdocs-git-revision-date-localized-plugin