文档规范

通用

1. 文档不要使用 Emoji 符号，使用合适的 ASCII 符号或文字描述。
2. 文档层级不要包含标题在内，不要超过 4 级，以 Markdown 为例，不要超过 ####。
3. 当文档层级过多，或文档内容过长时，将文档拆分，新文件命名，参考已有的文件。
4. 文档语言风格书面化、严谨、简洁、易懂。

Markdown

1. 语法格式符合 markdownlint 要求 https://github.com/DavidAnson/markdownlint?tab=readme-ov-file#rules--aliases。 其中关于 MD033 - Inline HTML，可以放宽，例如 img 可以使用 inline HTML。
2. 中文文档格式符合 autoCorrect 要求 https://github.com/huacnlee/autocorrect。
3. Markdown 可多选的样式，参考已有的文档，使用统一的样式。