跳转至

投稿指南

知识库中的正文统一使用 Markdown（轻量级标记语言）。你可以直接使用 GitHub 网页，也可以在本地通过 Git（版本控制系统）投稿。

投稿前

  1. 搜索是否已有相同主题，已有文章应优先补充；
  2. 确认内容可以公开；
  3. 删除密码、Token（访问令牌）、私钥、账号、个人信息和受限制材料；
  4. 准备必要图片，单张图片建议不超过 1 MiB；
  5. 选择比赛经验模板或知识分享模板。

文档放在哪里

内容 目录
比赛总结、复盘和踩坑 docs/competitions/
技术知识、工具教程和学习笔记 docs/knowledge/
新队员通用阅读材料 docs/learning/

复杂主题可以建立独立目录：

docs/competitions/2026-example/
├── index.md
└── images/
    └── architecture.webp

文件命名

使用小写英文、数字和连字符：

2026-mcc-summary.md
mpi-nonblocking-communication.md
linux-perf-basics.md

不要使用 最终版2.md、新建文档.md 之类无法表达主题的名称。Git 已经保存全部历史，不需要在文件名中维护版本号。

最少元数据

每篇文章顶部保留：

---
title: 清楚描述主题的标题
authors:
  - 作者姓名
date: 2026-08-03
category: 比赛经验
tags:
  - HPC
  - 性能优化
---
  • category 使用“比赛经验”或“知识分享”；
  • 一般使用 2 至 5 个准确标签；
  • 首次实质发布使用 date；内容发生明显变化时可增加 updated。

通过 GitHub 网页投稿

  1. 打开 Wiki_para 仓库；
  2. 进入目标目录，选择 Add file → Create new file 或 Upload files；
  3. 建议创建新分支并发起 Pull Request（拉取请求）；
  4. 自动检查通过后，由维护者合并；
  5. 主分支更新后，网站将重新构建和发布。

通过本地 Git 投稿

git clone https://github.com/Welmstr/Wiki_para.git
cd Wiki_para
git switch -c docs/add-topic-name

# 新建或编辑 Markdown 文档

git add docs/
git commit -m "docs: 添加主题说明"
git push -u origin docs/add-topic-name

随后在 GitHub 创建 Pull Request。

本地预览

建议使用 Python 虚拟环境（隔离的 Python 依赖环境）：

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

打开 http://127.0.0.1:8000/ 查看效果。提交前执行严格构建：

mkdocs build --strict

审核清单

  • 标题、作者、日期、分类和标签完整；
  • 文件位于正确目录；
  • 链接、图片和代码块可以正常显示；
  • 技术结论说明了适用环境和判断依据；
  • 不包含敏感信息或受限制内容；
  • 自动检查全部通过。

写作建议

  • 首次出现术语时同时给出中文解释；
  • 命令注明在哪种环境和目录运行；
  • 数据应说明测量方法，不只展示最好的一次；
  • 区分事实、经验判断和待验证猜想；
  • 引用他人内容时提供原始来源；
  • 失败方案和负向结果不要删除。