跳到正文

贡献指南

可加入编辑部提交贡献文档,或直接为本项目提交PR来贡献内容!在开始前,建议先阅读维护路线图TODO 汇总,这样更容易把贡献投到高优先级缺口上。

鸣谢贡献

正在加载贡献者列表...

极简markdown入门指南

如果你不想阅读长篇大论,可以直接划到本页面的最下方使用所见即所得的编辑器尝试markdown语法,在实践中学习!

前言

作为一种标记语言,Markdown的入门门槛其实和word差别不大,只需要熟悉一些关键符号,你就可以开始上手开始编辑markdown文档了。

我们仅仅使用接下来所述的一部分语法,事实上,这是一个能够满足本手册编辑排版需要的markdown语法的很小的一个子集:

  • 一级/二级/三级标题
  • 正文
  • 加粗
  • 斜体
  • 超链接
  • 必要的表格
  • 图片
  • 公式

下面我们将最简单的展现一些示例:

多级标题

markdown
# 一级标题

## 二级标题

### 三级标题

#### 四级标题

正文

不带任何格式特殊符号的文字即为正文,正文中如果包含格式特殊符号 如:#,$,^,* 等,请在特殊符号前面加上反斜杠\

示例:

markdown
这是普通正文内容,使用\*星号\*不会被解析为斜体

效果:

这是普通正文内容,使用*星号*不会被解析为斜体

加粗

用两个星号包裹文字:

markdown
**这是加粗文本**

效果:这是加粗文本

斜体

用一个星号包裹文字:

markdown
_这是斜体文本_

效果:这是斜体文本

超链接

方括号内放文字,圆括号内放URL:

markdown
[华工手册官网](https://manual.华南原神大学.com)

效果:华工手册官网

表格

用竖线分隔列,第二行用连字符定义表头:

markdown
| 课程               | 学分 |
| ------------------ | ---- |
| 微积分(II)(上) | 5    |
| 工科数学分析(下) | 5    |
| 工科数学分析(下) | 5    |

效果:

课程学分
微积分(II)(上)5
工科数学分析(下)5
工科数学分析(下)5

提示:第二行里面 " - " 横杠的个数是任意的,采用三个只是为了好看

引用

小于号(英文半角)加空格,后面即为引用内容。

语法:

> 这里是引用的内容

效果:

这里是引用的内容

图片

感叹号开头,方括号内是替代文本(加载不出来的时候显示的文本,有时候也会被解释为图片的题注),圆括号内是图片路径。

语法:

markdown
![华园星夜](https://www.scut.edu.cn/_upload/article/images/ed/e5/23bf2d62495b8528c27cb904af4b/f4f3d2a4-8653-48e4-9a33-adadb68a55d2.jpg)

效果:

华园星夜

公式(高级)

用美元符号包裹LaTeX公式:

如果你对LaTeX语法不甚熟悉,你可以使用可视化编辑器 在线LaTeX公式编辑器 进行公式编辑,并在输出区域下方点击“输出代码 > LaTeX”复制LaTeX代码,粘贴到下方的双美元符号之间,即可完成公式输入。

markdown
(单美元符号)行内公式:$ E=mc^2 $

(双美元符号)独立公式块:

$$
\sum_{i=1}^n i = \frac{n(n+1)}{2}
$$

效果:

行内公式:$ E=mc^2 $

独立公式块:

i=1ni=n(n+1)2

结语

掌握以上基础语法,你已能完成90%的文档排版需求。立即开始你的写作之旅吧!

即刻开始 Markdown

文档编撰规范

1. 附件命名规则

所有资源文件统一存放于 docs/public/ 目录下,并按类别或学区分文件夹管理。

  • 语言: 文件名使用英文
  • 分隔符优先级: 第一级用下划线 _,层级不足时用中划线 -,再不足时用小数点 .
  • 示例:
    • campus_map_hemc_2026.pdf — 大学城校区地图
    • bus_schedule_autumn_2026.pdf — 校巴时刻表
    • logo.scut_cat.1.png — Logo 图标

2. 来源标注与引用

引用官方信息

统一使用 Markdown 脚注:

markdown
根据学校规定,转专业申请需在第一学年末提交[^1]。

[^1]: 华南理工大学本科生转专业管理办法,https://www.scut.edu.cn/...

转载与整理

  • 转载或整理的信息,应尽量注明来源
  • 来源为内网或不便存档的链接,以文字写明出处即可(如"该数据来源于学校内部教务系统")
  • 免责声明: 转载/整理的页面须在 frontmatter 中设置 disclaimer: true。系统会自动在页面顶部注入统一的免责声明文本,避免各页手写导致不一致。

易失效资源

  • 若贡献者持有源文件(PDF、截图等),应存档至 docs/public/ 下对应目录
  • 若无源文件,按脚注格式标注来源即可

3. 外链规范

  • 站内链接: 使用根路由相对路径(如 /learn/curricular/exam),避免文档迁移后断链
  • 站外链接: 必须使用完整 URL,带 https:// 协议前缀
  • 来源偏好: 鼓励引用官方权威信息源,不对贡献者做强制约束
  • 死链处理: 维护过程中发现即修正;外部死链无法修复的,在原链接后用括号注明(该链接已失效)

4. 时间敏感信息管理

  • 统一标注: 涉及时效信息的页面,在正文开头添加标注:本页信息最后核对于 2026 年 7 月
  • 覆盖型内容: 迎新指南、校巴时刻表等完全过期的信息,直接覆盖更新,旧版本由 Git 历史保留
  • 积累型内容: 转专业经验帖等历年仍有参考价值的信息,保留不同年份版本,在标题或摘要中标明年份;主索引页面(如转专业总览)直接覆盖

5. 翻译同步规则

中文内容定稿后,应立即通过 LLM 翻译生成英文版,或直接将中文内容复制作为英文章节占位。

年度更新流程

高时效页面应每学年至少核对一次,确保信息准确。

  • 更新时间: 每年暑假(7 月—8 月)完成年度更新
  • 责任人: 项目的 maintainers 负责检查年度更新是否完成;任何贡献者发现过期信息均可提出 Issue 并提交 PR 自行更新
  • 追踪方式: 在下方核对表中标记进度

年度更新核对表

2026 年

  • 迎新指南 — get-started.md
  • 校巴时刻表 — life/time/bus.md
  • 大学城校区地图 — infra/hemc/map.md
  • 五山校区地图 — infra/wushan/map.md
  • 国际校区地图 — infra/gzic/map.md
  • 大学城校区周边 — infra/hemc/nearby.md
  • 穗石村信息 — infra/hemc/suishi.md
  • 五山校区周边 — infra/wushan/nearby.md
  • 国际校区周边 — infra/gzic/nearby.md
  • 校医院指南 — health/medical_care.md
  • 转专业政策 — learn/curricular/transfer_major.md

每年暑假开始时,maintainers 应复制上一年核对表创建新一年条目,并逐一核对。

CC0 1.0 Licensed