标准的格式是优质内容的基础,制定本规范的目的是统一文档内容中的中英文文字规范,提升内容的严谨度和美观度。 Handbook 编写规范,主要用来规范 Handbook 书写格式,统一中文文案、排版的相关用法,遵循我们 “Handbook优先(Handbook-First)” 的工作原则。
标准的格式是优质内容的基础,制定本规范的目的是统一文档内容中的中英文文字规范,提升内容的严谨度和美观度。
内容标题应具有足够的描述性,以便在脱离上下文看到相应片段时,能够理解其内容、
内容标题应从二级标题开始,一级标题是为页面标题保留的。
大多数标题都会自动生成片段标识符,选择标题时请注意这一点。
## 二级标题
#### 四级标题
二级标题 A
只包含一个三级标题,完全可以省略三级标题 A
。
## 二级标题 A
### 三级标题 A
## 二级标题 B
## 概述
### 概述
结构一
### 三级标题
#### 四级标题 A
#### 四级标题 B
#### 四级标题 C
结构二
### 三级标题
**(1)A**
**(2)B**
**(3)C**
每篇文章需要在开头添加以下内容,来展示本页目录。
{:.no_toc .hidden-md .hidden-lg}
- TOC
{:toc .hidden-md .hidden-lg}
中文文本的 Markdown 编写格式有别于英文文本,编写的不好很容易给读者带来凌乱之感。
错误:本文介绍如何快速配置GitLab。
正确:本文介绍如何快速配置 GitLab。
正确:今天出去买菜花了 5000 元。
错误:今天出去买菜花了 5000元。
错误:今天出去买菜花了5000元。
正确:我家的光纤入户宽带有 10Gbps,SSD 一共有 10TB。
错误:我家的光纤入户宽带有 10 Gbps,SSD 一共有 20 TB。
另外,度/百分比与数字之间不需要增加空格。
正确:今天是 233° 的高温。新 MacBook Pro 有 15% 的 CPU 性能提升。
错误:今天是 233 ° 的高温。新 MacBook Pro 有 15 % 的 CPU 性能提升。
正确:他的电脑是 MacBook Air。
错误:他的电脑是 MacBook Air 。
正确:Try Git commands right from your web browser. Featuring some of your soon-to-be favorites: branch, add, commit, merge, revert, cherry-pick, rebase!
错误:Try Git commands right from your web browser.Featuring some of your soon-to-be favorites:branch,add,commit,merge,revert,cherry-pick,rebase!
正确:此文档遵循 [Handbook 编辑规范](/handbook/about/style-guide/) 要求。
错误:此文档遵循[Handbook 编辑规范](/handbook/about/style-guide/) 要求。
错误:此文档遵循 [Handbook 编辑规范](/handbook/about/style-guide/)要求。
错误:此文档遵循[Handbook 编辑规范](/handbook/about/style-guide/)要求。
正确:核磁共振成像(NMRI)是什么原理都不知道?JFGI!
错误:核磁共振成像 (NMRI) 是什么原理都不知道? JFGI!
错误:核磁共振成像(NMRI)是什么原理都不知道?JFGI!
正确:这件蛋糕只卖 1000 元。
错误:这件蛋糕只卖 1000 元。
正确:乔布斯那句话是怎么说的?「Stay hungry, stay foolish.」
正确:推荐你阅读《Hackers & Painters: Big Ideas from the Computer Age》,非常的有趣。
错误:乔布斯那句话是怎么说的?「Stay hungry,stay foolish。」
错误:推荐你阅读《Hackers&Painters:Big Ideas from the Computer Age》,非常的有趣。
正确:branch, add, commit, merge, revert, cherry-pick, rebase!
错误:branch、add、commit、merge、revert、cherry-pick、rebase!
“Apple” 和 “Slack” 等品牌名称是专有名词,因此通常应大写。但如果品牌名称使用不寻常的大写,如“eBay”和“VMware”,则遵循品牌惯例。
正确:极狐(GitLab)
错误:极狐 gitlab
正确:我们需要一位熟悉 JavaScript、HTML5,至少理解一种框架(如 vue.js、AngularJS、React 等)的前端开发者。
错误:我们需要一位熟悉 Js、h5,至少理解一种框架(如 vue、angular、RJS 等)的 FED。