章节编写指导¶
本部分参考自 Linux 101 章节编写指导，有较大幅度的调整。以下将从两个方面：格式和内容，介绍如何编写章节。
格式要求¶
环境配置¶
Linux 201 使用 mkdocs + mkdocs-material 作为文档框架与主题，并且使用 autocorrect 进行中文格式检查，与 markdownlint-cli2 做 Markdown 格式检查。请阅读仓库下的 README.md 了解基本环境的配置。
主要作者¶
如果你编写了某个章节的一部分或全部内容，或为某个章节的写作思路提供了重要的帮助，请在 includes/authors.md 中添加你的 ID，类似于这样（假设你叫 example）：
然后章节开头的主要作者提示框格式类似如下：
不同名字之间使用中文全角顿号（即「、」）分隔。
章节编写状态¶
对于未定稿的内容，根据状态不同，请在 h1 标题下方添加如下内容：
或
或
使用提示框（Admonition）¶
提示框是 mkdocs-material 的特色功能。格式类似于如下：
效果如下：
警告标题
这是提示框的内容。
提示标题
这是提示框的内容，??? 表示默认折叠, 使用 ???+ 可以折叠, 但是默认展开。
我们使用的 mkdocs-material 提供的标准提示框有以下几种：
- note: 提示，表示重要的信息
- warning: 警告，表示需要特别注意的信息
- danger: 危险，表示如果忽视，可能导致严重后果的信息
- tip: 小技巧
- example: 示例
- question: 需要读者思考的问题
此外，我们自定义了一些提示框类型：
-
comment: 表示编者对内容的评论（类似于某些游戏的「Developer Commentary」），使用时请在标题处写上你的昵称，类似于这样：
效果：
-
lab: 教程不会详细说明，需要读者自己尝试的实验。
为标题和小标题添加 ID¶
由于文章篇目较长，使用时会经常遇到需要链接到文章某一段的情况。受限于 MkDocs 自动生成 Anchor ID 的功能（只支持英文字符），纯中文的标题会导致生成 _1, _2 这样的 ID。一方面这样的 ID 看起来不直观，另一方面每当标题发生增减时这些 ID 都会变，因此请为每个除了 h1 以外的标题手动添加一个有意义的 ID，方法如下：
建议 ID 只包含小写字母、数字和横线 -，必要时使用句点（不使用大写字母和其他标点符号）。
为图片添加配字¶
在图片下方写一行文字作为配字，并在这行字紧接着的下一行（不能有空行）写上 {: .caption }，这样配的这行字渲染成 HTML 时就加上了 class="caption"，显示为 0.94 倍的字体、灰色、贴近图片。
图片与附件文件¶
图片放置在 docs/images 目录，小的附件文件放置在 docs/assets/ 目录，编写 Markdown 时可以使用相对路径引用。
man 手册引用¶
includes/man.md 中包含了一些手册的在线阅读链接，类似如下：
按照指定格式添加后，使用如下方式引用：
定义列表¶
在写作时，我们可能会需要列出多个术语，同时给出它们的定义或者介绍，如果使用普通的有序或无序列表的话，给读者的观感可能过于紧凑。此时可以考虑使用定义列表格式，类似如下：
显示效果如下：
- 定义一
-
本项经常出现在科大西区和中区的交界处：肥西路上。在晚上九点之后，有概率可以在路边发现本项。
需要注意的是，离开校门时请带好手机。
- 定义二
-
我编不下去了。
内容要求¶
编写原则¶
请阅读首页，了解我们的四条编写原则。
请勿抄袭¶
请勿抄袭他人的文章。如果有参考，请在文中明确写明。
特别地，也不要使用 GPT 大段大段生成内容，然后直接提交。这样的内容即使正确性无误，也包含大量的废话，并且存在潜在的版权风险。
@taoky: 吐槽
比如说……