下面是一个例子

找到开源项目

打开下面 https://github.com/cargo-youth/ToolDiy.git

fork该项目

从你的 Github下载 ToolDiy

git clone https://github.com/Risingrode/ToolDiy.git

安装 mkdocs

下载链接:pip install mkdocs

安装网站主题

本站主题是material,使用下面命令进行安装即可。

pip install mkdocs-material

安装其它依赖

pip install pymdown-extensions
pip install mkdocs-awesome-pages-plugin

安装i18n

这里是个坑,我安装的时候,直接安装pip install i18n不行,你需要专门安装mkdocs下的i18n,然后问的chatGPT,他给我提供的解决方案是pip install mkdocs-i18n-plugin;可惜不对,最后在谷歌上找到下面命令,就对了。

pip install mkdocs-static-i18n

运行项目

mkdocs serve

构建静态网站文件

mkdocs build

推送到你的Github上面

点击pull request