参与贡献

本文介绍如何参与到项目的贡献中。

方法一：发表评论

在你想说点什么的网页底部发表一个评论。例如：

1）在首页底部点击「使用 GitHub 登录」：

2）输入文本后点击「评论」即可（评论支持 Markdown 格式及其预览）：

方法二：在线编辑

如果你想直接编辑网页中的内容，请按照下面的流程进行：

1）进入项目的 GitHub 地址，点击右上角的 Fork 按钮并确认：

2）回到对应的网页，点击右上角的「铅笔按钮」跳转到编辑页面：

3）编辑内容后点击「Create pull request」发起合并请求：

等维护者检查没问题后即可更新内容。

方法三：本地部署

该方法适合本地预览你的修改。

1）克隆仓库到本地：

https://github.com/Explorer-Dong/wiki.git
cd wiki

2）配置 Python 环境：

基于 uv基于 pip

安装项目依赖：

uv sync

激活虚拟环境：

WindowsLinux

source .venv/Script/activate

source .venv/bin/activate

创建 Python 虚拟环境：

python -m venv .venv

激活虚拟环境：

WindowsLinux

source .venv/Script/activate

source .venv/bin/activate

安装项目依赖：

pip install -r requirements.txt

3）启动本地服务：

mkdocs serve -f local.yml

之后你就可以进行修改或新增文件，具体规范见 行文规范。

4）推送到你的仓库后点击右上角的 Contribute 按钮发起 Pull Request：

行文规范

为了统一内容编排逻辑和文章写作风格，便于读者阅读，请严格遵循以下规范。

新增文件规范：

• 文件名：全部小写，适当缩写，使用 - 符号连接各单词，例如 ds-and-algo；
• 文件位置：请将需要补充的文件放置在 docs 文件夹下的合适位置，例如 templates-py.md 放在 ds-and-algo/ 下；
• 文件路径配置：将新增的文件路径添加到 mkdocs.yml 中。

文章写作规范：

• 标题：文章标题为 H2 至 H3，低于 H3 等级的标题不应再出现，可以采用段首加粗的形式；
• 链接：所有内链请采用相对引用的格式，例如 [基础知识](./base/index.md)；
• 更多文章写作规范可参考 OI Wiki 格式手册，这里不做严格约束。