中文技术文章排版

KooFE前端团队

关注

发布于: 2021 年 06 月 09 日

标题

标题层级

标题分为四级。

一级标题：文章的标题
二级标题：文章主要部分的大标题
三级标题：二级标题下面一级的小标题
四级标题：三级标题下面某一方面的小标题

标题示例：

# 一级标题## 二级标题### 三级标题#### 四级标题

复制代码

标题原则

1. 各级标题不能出现跨级

错误示例：

# 一级标题
### 三级标题

复制代码

2. 标题避免重名

错误示例：

## 错误示例
### 错误示例

复制代码

空格

中英文之间需要增加空格

正确示例：

本文中所有示例都是用 JavaScript 来实现

复制代码

错误示例：

本文中所有示例都是用JavaScript来实现。

复制代码

中文与数字之间需要增加空格

正确示例：

理想情况下入参个数应该不多于 2 个。

复制代码

错误示例：

理想情况下入参个数应该不多于2个。

复制代码

标点符号

中文语句中的标点符号使用全角符号

正确示例：

接下来，我们开始介绍如何将这些技巧应用在具体的开发实践中。

复制代码

错误示例：

接下来, 我们开始介绍如何将这些技巧应用在具体的开发实践中.

复制代码

括号内的内容为纯英文和数字或半角英文符号时用半角括号，括号前后加空格

正确示例：

这些良好的实践适用于任何编程语言，包括最接近硬件 (CTM) 的编程语言。

复制代码

错误示例：

这些良好的实践适用于任何编程语言，包括最接近硬件（CTM）的编程语言。

复制代码

专业术语要正确

英文的专业术语要书写正确，特别注意字母的大小写以及不能随意省略。相关用词可以参照 MDN 术语表。

正确示例：

学习 JavaScript 的正确姿势。

复制代码

错误示例：

学习 Javascript 的正确姿势。
学习 Js 的正确姿势。

复制代码

代码

明确代码所用的语言

Markdown 中的代码块，明确语言类型之后，代码才能正确高亮显示。

正确示例：

const name = 'koo';console.log(name)

复制代码

错误示例：

const name = 'koo';console.log(name)

复制代码

代码格式要优雅

空格、Tab、分号等用法要统一。

正确示例：

const name = 'koo';if (name === 'koo') {  console.log('Yes');} else {  console.log('No');}

复制代码

错误示例：

let name = 'koo';if (name === 'koo') {  console.log('Yes')} else {    console.log('No');}

复制代码

参考文档

发布于: 2021 年 06 月 09 日阅读数: 7

原文链接:【http://xie.infoq.cn/article/24a2a075ae5c6b38418d02b5c】。未经作者许可，禁止转载。

KooFE前端团队

关注

关注微信公众号： ikoofe 2021.05.29 加入

不定期更新一些前端方面的技术文章

发布

暂无评论

创作场景

中文技术文章排版

标题

标题层级

标题原则

空格

中英文之间需要增加空格

中文与数字之间需要增加空格

标点符号

中文语句中的标点符号使用全角符号

括号内的内容为纯英文和数字或半角英文符号时用半角括号，括号前后加空格

专业术语要正确

代码

明确代码所用的语言

代码格式要优雅

KooFE前端团队

评论