Skip to content
Xu Fasheng edited this page Feb 26, 2016 · 9 revisions
#+TITLE: Wiki 编写规范 *通用规则* 1. 可以使用任意 Github 支持的文档格式来编写 Wiki 页面,如 Markdown 或 Org,但某些经常被他人编辑的页面如 *Home* 和 *Categories* 建议 使用 Markdown 2. 新添加的页面需要经由管理员审核,尚未完善的 Wiki 建议先放置到 Home.md 中的 *草稿* 分类下 3. 默认使用中文编写 Wiki 页面,但文件名称均使用英文命名,且单词首字母 大写,单词与单词之间用破折号(-)连接。若是翻译文档,则在文件名后追 加对应的语言简称,如 *Wiki-Style-en.org* 4. 段落标题样式从 H2 开始,且段落后要空一行 5. 一般来说,若商标名称全部小写,在文档中出现时一般首字母大写[1],所以 应该总是使用 *Deepin* 而不是 *deepin* 6. 不要在 Wiki 加入别人无法访问的链接,如引用 [[https://tower.im][Tower]] 上的贴子 7. 某些英文简称按通用规范来使用,下面是一些示例 - JSON - DBus - PPPoE *中文 Wiki 特殊规则* 1. 中英文混排时数字或英文词汇两端 *无须* 用空格隔开 2. *建议* 总是使用中文全角下的标点符号 3. 常用英文词汇中文翻译列表 - Guidelines,指南 - Pull request,代码合并请求 *TODO* 1. 正文是否应该多次引用某个 URL [1] [[https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style/Trademarks#Trademarks_that_begin_with_a_lowercase_letter][Trademarks#Trademarks_that_begin_with_a_lowercase_letter]]

Clone this wiki locally