跳转至

😀 Mkdocs新建环境

MkDocs是一个快速、简单、华丽的静态站点生成器,适用于构建项目文档。文档源码使用Markdown来撰写,用一个YAML文件作为配置文件。它可以构建静态HTML站点并托管到GitHub Pages等地方。主题可以在这里找到。

Material for MkDocs是一个MkDocs的主题(每月下载量最多),Material for MkDocs特点包括开源、内置搜索、代码注释、社交卡与emoji支持

壹丨新建环境

rye add mkdocs-material mkdocs-glightbox neoteroi-mkdocs fonttools mkdocs-jupyter mkdocstrings-python

安装MkDocs

rye add mkdocs-material

安装glightbox

rye add mkdocs-glightbox

安装扩展插件

rye add neoteroi-mkdocs

MkDocs-Jupyter

MkDocs-Jupyter:在MkDocs中使用Jupyter Notebook

rye add mkdocs-jupyter

当报错ImportError: cannot import name 'AstRenderer' from 'mistune.renderers' (/home/MasterMao/anaconda3/envs/MasterMaoPy311/lib/python3.11/site-packages/mistune/renderers/__init__.py)时,需要更新下mistune

rye add mistune==3.0.1

字体工具

rye add fonttools

mkdocstrings-python

rye add mkdocstrings-python

管理页面顺序

rye add mkdocs-awesome-pages-plugin
plugins:
  - awesome-pages

贰丨常用命令

创建工程

mkdocs new [dir-name]
实时预览
mkdocs serve
构建站点
mkdocs build
打印帮助信息
mkdocs -h