在线部署 URL: https://genshin-impart.github.io/demo-doc/

使用 Python 自带的 venv 虚拟环境。

python3 -m venv ./venv

激活虚拟环境

• Linux

source venv/bin/activate

• Windows

.\venv\Scripts\activate

pip install mkdocs mkdocstrings mkdocs-material mkdocs-glightbox

在项目根目录下执行如下命令：

mkdocs serve

即可预览当前文档。

在项目根目录下执行如下命令（非必须）：

mkdocs build

即可将 docs 目录下的 markdown 文档转换为网页代码并存放在 site 目录下。

执行命令

mkdocs gh-deploy

即可将网页发布到 gh-deploy 分支下的 github pages 中。