Skip to content

Latest commit

 

History

History
89 lines (65 loc) · 2.15 KB

style.md

File metadata and controls

89 lines (65 loc) · 2.15 KB
Raw

文档格式约定

?> 创建新的文档以及对文档进行重构 (大规模修改已有内容) 时应套用此文件中约定的格式
编辑他人创建的文档时，请套用已有的格式并尽量与其他部分保持一致，不要随意修改他人的格式

用语约定

  • 文档阅读者: 您
  • 本平台: SakuraFrp
  • HTTP 或 HTTPS 隧道: HTTP(S) 隧道

符号约定

  • 用 空格 而不是 Tab 进行缩进
  • 用 \n 进行换行，文件内通常不应出现 \r
  • 空行不能包含空白字符，应该为单纯的 \n\n
  • 在没有特殊说明的地方均使用半角符号，如: :，.，<，>，(，)。通常这些符号后面需要加上一个空格来确保间距合理
  • 在文字段落中均采用 ， 逗号，每句话结尾需添加 。 句号，段末通常以 。 或 : 结尾
  • 列表条目、?> 提示块、!> 提示块通常不以 。 结尾

文本间距

在正常文本和半角标点之间应添加空格，半角标点和全角标点之间无需空格:

文本文本 `修饰块` 文本文本 **修饰块** 文本
       ^ 空格   ^ 空格   ^ 空格     ^ 空格

文本文本 `修饰块`，文本文本 (文本文本) 文本
       ^ 空格            ^ 空格     ^ 空格

文本文本。`修饰块`、文本文本
         ^ 半角、全角标点之间无需空格

文本修饰

使用 * 添加粗体、斜体效果:

*斜体*

**粗体**

***粗斜体***

无序列表

使用 - 作为列表标记，标记后添加一个空格:

- ItemA
- ItemB

如果存在多级列表，每级列表均缩进两个空格，使得下一级的 - 与上一级内容的第一个字符对齐:

- ItemA
- ItemB
  - ItemB1
  - ItemB2
- ItemC
  - ItemC1
    - ItemC11
    - ItemC12
      - ItemC121

有序列表

使用 1. 作为列表标记，标记后添加一个空格:

1. ItemA
1. ItemB
1. ItemC

如果存在多级列表，每级列表均缩进三个空格，使得下一级的 1 与上一级内容的第一个字符对齐:

1. ItemA
1. ItemB
   1. ItemB1
   1. ItemB2
      1. ItemB21
1. ItemC