格式要求

贡献文档要求

当你打算贡献某部分的内容时，你应该尽量熟悉以下三部分：

• 文档存储的格式
• 文档的合理性

文档引用与存储的格式

• 文件名请务必都小写，以 - 分割。 例如：file-name.md。

• 请务必确保文档中引用的 外链 图片已经全部转存到了 本库内 对应的 images 文件夹中（防止触发某些网站的防盗链），建议处理成 MD 文档名称 + 编号 的形式（可参考已有文档中图片的处理方式）。例如：本篇文档的文件名称为 format，则文档中引用的第一张图片的名字为 format1.png。

• 请确保您的文档中的引用链接的稳定性，防止岁月史书和 404 。建议在添加时同时将该外链存于互联网档案馆。

• 站内链接请去掉网站域名，并且使用相对路径链接对应 .md 文件。例如，在本页面（intro/format）中链接杂项简介（misc），应使用 [杂项简介](../misc/index.md)。可以在链接中添加 hash 来链接到某一节，例如 [Pull Request 信息格式规范](./htc.md#pull-request-信息格式规范)，hash 的值可以通过位于每个标题右侧的按钮或者位于网页右侧的目录中的链接得到。

文档的合理性

绝对禁止的行为

• 在文档中包含公民个人信息
• 以过于露骨或尖锐的方式对当局进行批判
• 散播可能影响社会稳定的谣言

文档的基本格式要求

文本内容的格式要求

• 作为一个偏向严肃的资料库，主体文本应使用书面语，保持客观和冷静。
• 在页面的开头应有一段简短的文字，用于概述页面内容。
• 请为链接提供完整的标题，避免使用“本文”、“相关页面”等模糊描述。
  • 不推荐：请参考这篇报道
  • 推荐：请参考《财新周刊》的报道《清华“腚姐”事件的舆论观察》^ref1。
• 强调：表示强调时请使用 **文本**。
• 引用：引用某一方的观点或原文时，请使用 Markdown 的引用区块格式 > 文本内容。
• ## 参考资料与注释 二级标题必须放在文末。

标点符号的使用

• 请在每句话的末尾添加 句号。
• 请正确使用 全角 标点符号与 半角 标点符号。中文语境下请使用全角符号（如 ，、。、（）），英文或数字两侧使用半角符号。
• 引号请使用 「……」（全角）和 "..."（半角），以明确区分。

Markdown 格式与主题扩展格式要求

• 一级标题：不要使用如 <h1> 或 # 标题 的一级标题，页面标题由系统自动生成。
• 折叠框：对于可能引起争议的、或过于细节的补充材料，建议使用主题扩展的 ???+note 格式（即可折叠区块）来呈现。
  • 示例代码： text ???+note "关于“仙人跳”叙事的进一步讨论" 这里可以放置更深入的分析或不同角度的补充材料。 推荐将具有强烈争议性的观点放在折叠文本框内，以保持主干内容的中立性。
  • 效果： ???+note "关于“仙人跳”叙事的进一步讨论" 这里可以放置更深入的分析或不同角度的补充材料。 推荐将具有强烈争议性的观点放在折叠文本框内，以保持主干内容的中立性。
• 脚注：「参考资料与注释」使用 Markdown 的脚注功能进行编写。
  • 格式为： markdown 文本内容。[^脚注名] [^脚注名]: 参考资料内容。注意：冒号是英文冒号，冒号后面跟着一个空格。
  • 脚注名建议使用统一规律，如：ref1、ref2、note1……
  • 脚注的内容统一放在 ## 参考资料与注释 二级标题下。

  • 示例： ```markdown 2022年6月，唐山一家烧烤店发生了一起暴力殴打事件，引发全国性关注 [^ref2]。

    参考资料与注释

    [^ref2]: 唐山烧烤店打人事件 - 维基百科，自由的百科全书。 ```