From 228ab498762ba6fc8138b4bec8d9fde8dca44610 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=B5=B5=E6=98=8E=E6=9C=88?= Date: Thu, 14 Jul 2022 11:02:12 +0800 Subject: [PATCH] Update the file 106-contribute-to-docs.md space specification Signed-off-by: Mingyue Zhao --- articles/106-contribute-to-docs.md | 28 +++++++++++++++++++--------- 1 file changed, 19 insertions(+), 9 deletions(-) diff --git a/articles/106-contribute-to-docs.md b/articles/106-contribute-to-docs.md index 22403af..e5e4c88 100644 --- a/articles/106-contribute-to-docs.md +++ b/articles/106-contribute-to-docs.md @@ -134,12 +134,22 @@ OpenAnolis 龙蜥社区相关的术语有如下规范： 4. 不建议标题使用过多层级，尽量控制在三级及三级以内。 3. 文档编写过程中，不要求换行（例如100字换行，80字换行），而且我们也不推荐换行操作，对于不同 Markdown 渲染器，换行带来的格式影响是不一致的； 4. 中英文、中文数字混排，**必须**要用空格。即，中文和英文之间，应当使用一个半角空格；中文和数字之间，应当使用一个半角空格。举例如下： -```md -接受 Reviewer 的检查 # 符合要求 -基于PR提交 # 不符合要求 -2015 年 10 月 1 日 # 符合要求 -2013年3月 # 不符合要求 -``` -5. 嵌入图片的要求，在上一节已经说明； -6. 如果表示突出（但是没有很强烈的强调意味），可以用 `_内容_` 来实现斜体字；如果表示强调，可以用 `**强调**` 来实现粗体字； -7. 文件路径、命令、简短的代码需要使用反引号 '\`' 引用为 inline-quote。例如：`/etc/os-release`, `./execute.sh`；如果是大段代码，需要使用单独的 '\`\`\`' 代码块，并推荐注明对应的代码所属语言。 + 1. 中英文、中文与数字之间空格规范 + + 正确：Anolis OS 8 是 OpenAnolis 社区发行的开源 Linux 发行版。 + + 错误：Anolis OS 8是 OpenAnolis社区发行的开源Linux 发行版。 + 2. 数字与单位之间空格规范 + + 正确：Anolis OS 100% 兼容 CentOS。 + + 错误：Anolis OS 100 % 兼容 CentOS。 + + 正确：Anolis OS 8.6 Boot ISO 大概只有 900 MB。 + + 错误：Anolis OS 8.6 Boot ISO 大概只有 900MB。 +5. 标点符号规范 + 1. 不重复使用标点符号 + + 正确：Anolis OS 8.6 版本正式发布了！ + + 错误：Anolis OS 8.6 版本正式发布了！！！ + 2. 使用全型中文标点符号 + + 正确：Anolis OS 8 操作系统搭载双内核 RHCK（RHEL Compatible Kernel）和 ANCK（OpenAnolis Cloud Kernel）。 + + 错误：Anolis OS 8 操作系统搭载双内核 RHCK(RHEL Compatible Kernel)和 ANCK(OpenAnolis Cloud Kernel)。 +6. 嵌入图片的要求，在上一节已经说明； +7. 如果表示突出（但是没有很强烈的强调意味），可以用 `_内容_` 来实现斜体字；如果表示强调，可以用 `**强调**` 来实现粗体字； +8. 文件路径、命令、简短的代码需要使用反引号 '\`' 引用为 inline-quote。例如：`/etc/os-release`, `./execute.sh`；如果是大段代码，需要使用单独的 '\`\`\`' 代码块，并推荐注明对应的代码所属语言。 + -- Gitee