外观
文档编写规范
约 1207 字大约 4 分钟
2025-12-22
逼话
不以规矩无以成方圆
Nothing can be accomplished without norms or standards
MD 文件请使用英文命名
正例
specification.md反例
文档编写规范.md文档必须有frontmatter
标题会渲染到文本顶部和左边侧边栏的标题
---
title: 这里写标题, 例如 文档编写规范
createTime: 这里写时间, 例如 2025/12/22 12:48:13
---版权
这是一个很重要的规范, 故写在frontmatter规范下面
在frontmatter中添加copyright字段, 默认是CC-BY-4.0, 可以不用写.
文档自带的版权
- CC0 1.0 通用 (CC0)
- 署名 4.0 国际 (CC-BY-4.0)
- 署名-相同方式共享 4.0 国际 (CC-BY-SA-4.0)
- 署名-非商业性 4.0 国际 (CC-BY-NC-4.0)
- 署名-禁止演绎 4.0 国际 (CC-BY-ND-4.0)
- 署名-非商业性-相同方式共享 4.0 国际 (CC-BY-NC-SA-4.0)
- 署名-非商业性-禁止演绎 4.0 国际 (CC-BY-NC-ND-4.0)
原创文章
---
title: 我的文章
createTime: 这里写时间, 例如 2025/12/22 12:48:13
copyright: CC-BY-4.0
---版权归属：洱海
转载文章
---
title: 转载的文章
createTime: 这里写时间, 例如 2025/12/22 12:48:13
copyright:
creation: reprint
license: CC-BY-4.0 (版权)
source: https://example.com/origin (来源)
author:
name: 转载者 (作者)
url: https://example.com/author (作者网站)
---翻译文章
---
title: 翻译的文章
createTime: 这里写时间, 例如 2025/12/22 12:48:13
copyright:
creation: translate
license: CC-BY-4.0 (版权)
source: https://example.com/origin (来源)
author:
name: 转载者 (作者)
url: https://example.com/author (作者网站)
---自定义
---
title: 我的文章
createTime: 这里写时间, 例如 2025/12/22 12:48:13
copyright:
license:
name: MIT (版权)
url: https://example.com/mit (版权地址)
---版权归属：洱海
许可证：MIT
每篇文档有且不能有一级标题
标题请在frontmatter中添加
正例
---
title: 这里写标题, 例如 文档编写规范
createTime: 这里写时间, 例如 2025/12/22 12:48:13
---反例
# 标题每个结构之间空一行
不这么做会渲染错误
正例
# 标题1
# 标题2
第1行
第2行
* 第1项
* 第2项
* 第3项反例
# 标题1
# 标题2
第1行
第2行
* 第1项
* 第2项
* 第3项代码块内的内容需在编辑器中格式化
这样看起来好看一点, 并且和其他文档格式保持一致
正例
```javascript
let i = 1;
while (i <= 3) {
console.log(`这是我循环的第${i}遍`)
i++
}
```反例
```javascript
let i=1;
while(i<=3){
console.log(`这是我循环的第${i}遍`)
i++
}
```代码块缩进大小为制表符4
正例
```javascript
let i = 1;
while (i <= 3) {
console.log(`这是我循环的第${i}遍`)
i++
}
```反例
```javascript
let i = 1
while (i <= 3) {
console.log(`这是我循环的第${i}遍`)
i++
}
```加粗两边不需要加空格
正例
**JS**全称**JavaScript**, 是一门跨平台, 面向对象的脚本语言, 它能使网页可交互(例如拥有复杂的动画, 可点击的按钮,
通俗的菜单等)反例
**JS** 全称 **JavaScript** , 是一门跨平台, 面向对象的脚本语言, 它能使网页可交互(例如拥有复杂的动画, 可点击的按钮,
通俗的菜单等)逗号后面需加空格
正例
**JS**全称**JavaScript**, 是一门跨平台, 面向对象的脚本语言, 它能使网页可交互(例如拥有复杂的动画, 可点击的按钮,
通俗的菜单等)反例
**JS**全称**JavaScript**,是一门跨平台,面向对象的脚本语言,它能使网页可交互(例如拥有复杂的动画,可点击的按钮,通俗的菜单等)优先使用文档内置的组件
正例
提示
1 + 1 = 2
反例
注意: 1 + 1 = 2
更多组件, 请浏览文档组件
版权所有
版权归属：洱海