跳到主要内容

文档写作规范

本文档用于规范文档的写作,以便于文档的统一性。

书写规范

  1. 文档一般使用 Markdown 语法进行书写,文件后缀为.md
  2. 中文写作需遵守中文文案排版指北
  3. 对于需要提示的内容,善用 Admonitions 语法,如下:
    :::note
    这是一个笔记,用于次要的补充说明,如提示读者此处的内容是可选或者不完整的
    :::
    :::tip
    这是一个提示,用于补充一般的说明信息
    :::
    :::caution
    这是一个警告,用于强调容易忽略的信息
    :::
    :::danger
    这是一个危险,用于强调禁止行为
    :::
    备注

    这是一个笔记,用于次要的补充说明,如提示读者此处的内容是可选或者不完整的

    提示

    这是一个提示,用于补充一般的说明信息

    警告

    这是一个警告,用于强调容易忽略的信息

    危险

    这是一个危险,用于强调禁止行为