编写规范

推荐的代码编辑器

Visual Studio Code

并搭配以下扩展使用

• 💡markdownlint
• 💡Markdown All in One
  • 将此扩展作为默认的格式化工具
• Markdown Preview Mermaid Support
• Markdown Preview Github Styling

语言风格

语言应中立严谨，而风格可稍微略带口语化、活泼幽默或添加 Emoji 以避免文章死板无味，但是也不要太多以至于显得过于抽象🤔

对于严肃的话题（如校规校纪），为避免歧义，应保持以书面语为主

广告

任何页面均不允许包含任意形式的广告，包括但不限于校园卡、二手书推销

提示

游戏群、二手群、校园墙等联系方式可添加在黄页§非官方页面

Markdown 语法规范

Markdown 文档应符合基本语法，并参考推荐规范进行编写，并允许一定的扩展语法

规范太多不好写？

别担心🤓👍这并不需要你过于操心

• 在提交前会自动使用@lint-md/cli自动修复部分问题
• 提交后和 PR 后会自动使用 GitHub Actions 进行文档检查
  • 等待运行结束后可以查看输出定位问题

扩展语法

• VitePress提供的 Markdown 扩展语法
• markdown-it插件提供的扩展语法
  • 脚注
  • 数学公式
  • 角标
  • 任务勾选框
• Mermaid

推荐规范

• 💡中文技术文档的写作规范 ruanyf/document-style-guide
• 💡中文文案排版指北 mzlogin/chinese-copywriting-guidelines
• GitHub Flavored Markdown Spec（英）
• GitHub 风格的 Markdown 规范（前者的非官方中文译本）

引用标注

为提高本站内容的可信度，对于引用非本站的内容（书籍文本、小红书、贴吧、政府或校方的规定或通知、新闻等），需要参考GB/T 7714-2015《信息与文献 参考文献著录规则》或论文中引用网页内容在文中怎么标注？标注引用来源

• 考虑到此标准过于详细复杂，大部分情况下只需保证本站内所有页面的引用格式统一即可，具体格式见下
• 日期均采用YYYY-MM-DD格式表示，一位数的数字前需补0，如2025-05-14
• 在引用文本片段末尾添加角标，在页面末尾添加引用来源说明

格式

[^n]: 发布主体.标题 (发布日期)\[引用日期]
<链接>

当发布日期或引用日期不明确或缺失时可省略

示例

这是一段文本[^1]

[^1]: 合肥工业大学.@全体 HFUTers，快来 pick 校全媒体中心！ (2021-03-27)[2024-10-03]
<https://mp.weixin.qq.com/s/L6Pv3mONAEVUwZ_dcDJV1g>

解析后如下

这是一段文本^[1]

1. 合肥工业大学.@全体 HFUTers，快来 pick 校全媒体中心！ (2021-03-27)[2024-10-03]
   https://mp.weixin.qq.com/s/L6Pv3mONAEVUwZ_dcDJV1g ↩︎

贡献者

gforoosge

页面历史

最后编辑于 1 天前

查看完整历史

1c083d7-✨ 添加编写规范