|
7 | 7 | - [原始定义](https://daringfireball.net/projects/markdown/) |
8 | 8 | - [GitHub 的教程](https://guides.github.com/features/mastering-markdown/) |
9 | 9 |
|
10 | | -## 中文排版 |
11 | | - |
12 | | -- [空格](https://github.com/mzlogin/chinese-copywriting-guidelines#%E7%A9%BA%E6%A0%BC): |
13 | | - - 中英文之间需要增加空格。 |
14 | | - - 中文与数字之间需要增加空格。 |
15 | | - - 数字与单位之间无需增加空格。 |
16 | | - - 全角标点与其他字符之间不加空格。例外:裸链接后面需空格,不能紧跟标点,否则有些渲染器会把标点当成链接的一部分。 |
17 | | - - 中文与链接、强调、行内代码等格式间是否加空格取决于内容(即以上规则),比如`书写 *Markdown* 的规范`需要加,而`书写*中文*的规范`不需要加。 |
18 | | - |
19 | | - 示例: |
20 | | - |
21 | | - ```markdown |
22 | | - 大家好,我是 Aaron Wang,生于 1989 年,身高 173cm,*GitHub* 链接 https://github.com/inetfuture 。 |
23 | | - ``` |
24 | | - |
25 | | -- [全角与半角](https://github.com/mzlogin/chinese-copywriting-guidelines#%E5%85%A8%E8%A7%92%E5%92%8C%E5%8D%8A%E8%A7%92): |
26 | | - - 主体是中文的时候(夹杂少量英文单词、术语、短句),应全部使用全角中文标点,不要随意混杂半角标点。 |
27 | | - |
28 | | - ```markdown |
29 | | - // 错误的 |
30 | | - 中文夹杂 English words, 标点不要乱. |
31 | | - |
32 | | - // 正确的 |
33 | | - 中文夹杂 English words,标点不要乱。 |
34 | | - ``` |
35 | | - |
36 | | - - 遇到完整的英文整句(引用)、特殊名词等时,其內容才可酌情使用半角标点。 |
37 | | - - 数字使用半角字符。 |
38 | | -- 标点: |
39 | | - - [中文列举间隔使用顿号(`、`)而不是逗号(`,`)](https://zhuanlan.zhihu.com/p/83934100)。 |
40 | | - - 列表项目结尾是在引出详细描述时,用冒号结束,比如: |
41 | | - |
42 | | - ```markdown |
43 | | - - 使用示例: |
44 | | - |
45 | | - '''shell |
46 | | - whatever xxx |
47 | | - ''' |
48 | | - ``` |
49 | | - |
50 | | - - 句末加句号,特别短的(不是完整句子)可以例外,但是注意保持一致。 |
51 | | - |
52 | 10 | ## 语义 |
53 | 11 |
|
54 | 12 | 格式使用应遵守语义: |
|
163 | 121 | ''' |
164 | 122 | ``` |
165 | 123 |
|
| 124 | +## 中文排版 |
| 125 | + |
| 126 | +- [空格](https://github.com/mzlogin/chinese-copywriting-guidelines#%E7%A9%BA%E6%A0%BC): |
| 127 | + - 中英文之间需要增加空格。 |
| 128 | + - 中文与数字之间需要增加空格。 |
| 129 | + - 数字与单位之间无需增加空格。 |
| 130 | + - 全角标点与其他字符之间不加空格。例外:裸链接后面需空格,不能紧跟标点,否则有些渲染器会把标点当成链接的一部分。 |
| 131 | + - 中文与链接、强调、行内代码等格式间是否加空格取决于内容(即以上规则),比如`书写 *Markdown* 的规范`需要加,而`书写*中文*的规范`不需要加。 |
| 132 | + |
| 133 | + 示例: |
| 134 | + |
| 135 | + ```markdown |
| 136 | + 大家好,我是 Aaron Wang,生于 1989 年,身高 173cm,*GitHub* 链接 https://github.com/inetfuture 。 |
| 137 | + ``` |
| 138 | + |
| 139 | +- [全角与半角](https://github.com/mzlogin/chinese-copywriting-guidelines#%E5%85%A8%E8%A7%92%E5%92%8C%E5%8D%8A%E8%A7%92): |
| 140 | + - 主体是中文的时候(夹杂少量英文单词、术语、短句),应全部使用全角中文标点,不要随意混杂半角标点。 |
| 141 | + |
| 142 | + ```markdown |
| 143 | + // 错误的 |
| 144 | + 中文夹杂 English words, 标点不要乱. |
| 145 | + |
| 146 | + // 正确的 |
| 147 | + 中文夹杂 English words,标点不要乱。 |
| 148 | + ``` |
| 149 | + |
| 150 | + - 遇到完整的英文整句(引用)、特殊名词等时,其內容才可酌情使用半角标点。 |
| 151 | + - 数字使用半角字符。 |
| 152 | +- 标点: |
| 153 | + - [中文列举间隔使用顿号(`、`)而不是逗号(`,`)](https://zhuanlan.zhihu.com/p/83934100)。 |
| 154 | + - 列表项目结尾是在引出详细描述时,用冒号结束,比如: |
| 155 | + |
| 156 | + ```markdown |
| 157 | + - 使用示例: |
| 158 | + |
| 159 | + '''shell |
| 160 | + whatever xxx |
| 161 | + ''' |
| 162 | + ``` |
| 163 | + |
| 164 | + - 句末加句号,特别短的(不是完整句子)可以例外,但是注意保持一致。 |
| 165 | + |
166 | 166 | ## 其它 |
167 | 167 |
|
168 | 168 | - 表示带变量的字符串时,使用 `${var}` 的形式(同 Shell): |
|
171 | 171 | username 规则:`${firstName}.${lastName}` |
172 | 172 | ``` |
173 | 173 |
|
174 | | - 有惯例的除外,比如表示 RESTful API 的 path 参数可遵循 Swagger 的风格:`/blogs/{blogId}`。 |
| 174 | + 有惯例的除外,比如表示 RESTful API 的 path 参数可遵循 Swagger 的风格:`/articles/{articleId}`。 |
175 | 175 |
|
176 | 176 | - 表示命令行选项(option)、参数(arg)时,参考各种 manual 里的惯例写法,可选的放在 `[]` 中,必需的放在 `<>` 中: |
177 | 177 |
|
|
181 | 181 |
|
182 | 182 | - 描述菜单、目录导航使用 `【xxx】>【xxx】` 的写法。 |
183 | 183 | - 英语专有名词大小写、符号等遵循官方的写法,比如 macOS、Microsoft、GitLab、PostgreSQL、MongoDB、InfluxDB、Elasticsearch、Node.js、gRPC、Vue.js、React、HTML、MaiSCRM 等。 |
| 184 | +- 英语标题除介词、连词等外应首字母大写,可参考 [Capitalize My Title](https://capitalizemytitle.com/) 的结果。 |
184 | 185 |
|
185 | 186 | ## 编辑器 |
186 | 187 |
|
|
0 commit comments