跳转至

加入我们!怎么参与到这个项目中?

基础知识

本项目源代码托管于 GitHub,使用 Markdown 语法编写,使用 MkDocs Material 生成静态网页。如果你不熟悉这些工具,可以参考 GitHub 官方文档MkDocs Material 官方文档

1. 加入 GitHub 私有仓库

本仓库由朱老板管理,如果你想加入这个项目,可以联系朱老板,他会将你加入到 GitHub 私有仓库中。

2. 本地 Git 账户配置

在本地配置 Git 账户,以便在本地提交代码。

git config --global user.name  "Your Name"
git config --global user.email "Your E-mail"

用户名和邮箱

请务必提前设置好,否则脚本抓取贡献者时会出现错误。

3. 本地部署

你需要下载如下几个 Python 包,用于本地部署网页。

pip install mkdocs-material
pip install mkdocs-git-revision-date-localized-plugin
pip install mkdocs-git-authors-plugin
pip install mkdocs-git-committers-plugin-2
pip install mkdocs-encryptcontent-plugin

将本仓库克隆到本地,然后在仓库根目录下执行 mkdocs serve,然后在浏览器中输入 http://127.0.0.1:8000 即可预览网页。

4. 添加新内容

如果你想添加一个单独的页面,可以在 docs 目录下新建一个 .md 文件,然后在 mkdocs.ymlindex.md 文件中添加该文件的路径。

添加图片

如果你想添加图片,请将图片放在 docs/assets/images 下对应主题的子目录中,文件名使用 snake_case,并按页面层级使用相对路径引用(例如一级页面用 ../assets/images/...,二级页面用 ../../assets/images/...)。

5. 提交代码

在本地修改完代码后,可以使用如下命令提交代码。

git add .
git commit -m "Your commit message"
git push
Page Authors: Siris-Li (86.27%), Bwoah-Kimi (13.73%)