跳转至

站点维护与投稿方法

本文适用于站点内容维护、送检记录补充,以及其他 Markdown 文档投稿场景。

维护或投稿流程

1. 克隆仓库到本地

先将仓库拉取到本地,建议在自己的分支上完成修改。可根据实际使用的平台选择以下任一地址:

git clone https://github.com/Tangrenbin/hplc-club

或:

git clone https://gitee.com/tangrenbin/hplc-club

2. 在 md_doc/ 目录中新增或修改文档

站点文档源目录为 md_doc/。新增内容时,请直接在该目录下创建 .md 文件,例如:

  • 浙江25年2批送检记录.md
  • 辽宁26年1批送检记录.md

文件名建议尽量直观,能直接体现地区、时间、批次和主题,便于后续检索和维护。

3. 如需插图,请将图片放入 md_doc/image/

如果文档中需要插入截图或现场照片,建议统一放到 md_doc/image/ 目录,并在 Markdown 中使用相对路径引用,例如:

![示例图片](image/liaoning-2026-batch1-01.jpg)

4. 完成自查后提交变更

请检查以下内容后再提交:

  • 标题是否清晰
  • 文件名是否规范
  • 图片路径是否正确
  • 语句是否通顺,日期是否明确

5. 发起 Pull Request 或 Merge Request

提交代码后,发起评审流程。若仓库托管在 GitHub,通常使用 Pull Request;若托管在 Gitee,通常使用 Merge Request。

6. 合并后自动同步到站点

变更合并到主分支后,站点会自动构建并发布。新增的 Markdown 文档也会自动出现在站点导航中,无需额外修改导航配置。

7. Git 使用有困难时,可通过邮件投稿

如果暂时不方便使用 Git,也可以直接将投稿内容发送到邮箱:

  • 2890015861@qq.com

建议邮件中附上以下内容:

  • 文档标题
  • 正文内容或 Markdown 附件
  • 如有图片,请一并附上
  • 如需署名,可在邮件中注明

收到邮件后,可由维护者协助整理并发布到站点。

内容撰写建议

  • 一级标题建议与文件主题保持一致
  • 建议按“修改点、原因、日期、附件”组织内容
  • 日期建议使用明确格式,例如 2026-03-30
  • 如有外部仓库、图片或附件,建议补充简短说明

推荐模板

可参考以下写法:

# 浙江25年2批送检记录

## 修改点一

- 描述本次修改内容

### 原因

- 说明为什么需要这样修改

### 修改日期

- 2026-03-30

可选:本地预览

如需在提交前预览站点效果,可在仓库根目录执行:

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements-docs.txt
mkdocs serve

启动后默认访问地址为 http://127.0.0.1:8000