Dev.相关 | markdown 语法总结备忘
文章写作规范
标题与正文
标题后应当有单独空行。
## the great title
content line 1
content line 2
## the great title
content line 1
content line 2
同一段落，在句子后加上两个空格（不建议，除非全篇所有句末都使用此方法换行）或html标签<br>换行。
不同段落，段落间用空行隔开
line 1
line 2
line 1<br>
line 2
写作排版与风格
中文字符与半角英文/数字间，应使用半角空格隔开。
本服务器和整合包含的所有 Mods 的著作权归 Mod 各自的著作权持有人所有。
在句中使用全角标点符号，使用直角引号「」代替西文引号“”。
如整句均为英文，则使用半角标点符号和西文引号。
「不，听说那是绵月大人本人想让我们看的东西呢。」
He published an article entitled "The Future of the Aviation".
半角英文字符和半角阿拉伯数字，与全角标点符号之间不留空格。
英文单位若不翻译，单位前的阿拉伯数字与单位间不留空格。
英文原文如果使用了复数形式，翻译成中文时，应该将其还原为单数形式。
他的电脑是 MacBook Air。
一部容量为 16GB 的智能手机
⋯information stored in random access memory (RAMs)⋯
……存储在随机存取存储器（RAM）里的信息……
对于单个句子，应避免其超过40个字，尽量使用简单句和并列句，避免使用复合句。
尽量不使用被动语态，改为使用主动语态。
同样一个意思，尽量使用肯定句表达，不使用否定句表达。
避免使用双重否定句。
本产品适用于多种体系结构。无论是由一台服务器（单一节点结构），还是由多台服务器（并行处理结构）进行动作控制，均可以使用本产品。
请确认装置的电源已关闭。
用户必须拥有删除权限，才能删除此文件。
本产品适用于从由一台服务器进行动作控制的单一节点结构到由多台服务器进行动作控制的并行处理程序结构等多种体系结构。
请确认没有接通装置的电源。
没有删除权限的用户，不能删除此文件。
markdown 语法
基本语法
以下内容可以在任意md文件中应用。
标题
创建标题，该元素在渲染时会置于目录中。
注意#前的空格。
应尽量减少多级标题的使用，避免使用三级以上标题。
以二级标题作为顶级标题也是可行的。
.md 文件：
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
渲染效果：
强调文本
.md 文件中的内容：
**应用粗体（Bold）的文本**
*应用斜体（Italic）的文本*
***同时应用粗体，斜体的文本***
~~应用删除线的文本~~
渲染效果：
应用粗体（Bold）的文本
应用斜体（Italic）的文本
同时应用粗体，斜体的文本
应用删除线的文本
引用块
.md 文件中的内容：
> 单行引用文本
> 多行引用文本 line 1<br>
> line 2
> 多段落引用文本<br>
> *注意道岔限速<br>
> *注意道岔限速
>
> *双黄灯，侧线运行<br>
> *双黄灯，侧线运行
渲染效果：
单行引用文本
多行引用文本 line 1
line 2
多段落引用文本
*注意道岔限速
*注意道岔限速*双黄灯，侧线运行
*双黄灯，侧线运行
列表
对于提到的几种写法，在同一个文件中应只使用一种。
.md 文件中的内容：
<!-- 有序列表，几种写法等效。 -->
1. 飞行操纵......检查（左右座）
2. 飞行仪表......检查（左右座）
3. 简令.........证实
4. 襟翼调定......形态__(左右座)
1. 飞行操纵......检查（左右座）
1. 飞行仪表......检查（左右座）
1. 简令.........证实
1. 襟翼调定......形态__(左右座)
1. 飞行操纵......检查（左右座）
9. 飞行仪表......检查（左右座）
1. 简令.........证实
9. 襟翼调定......形态__(左右座)
<!-- 无序列表，几种写法等效。 -->
- 航路总距离...，总时间...
- 使用跑道... / 跑道条件...
- 标准离港程序（SID）...
- 起始高度 ...
* 航路总距离...，总时间...
* 使用跑道... / 跑道条件...
* 标准离港程序（SID）...
* 起始高度 ...
+ 航路总距离...，总时间...
+ 使用跑道... / 跑道条件...
+ 标准离港程序（SID）...
+ 起始高度 ...
<!-- 列表使用缩进嵌套 -->
- 复飞
- 发口令“复飞，襟翼”
- 加油门到TOGA
- 跟指引，襟翼向前收一档
- 备降场...
渲染效果：
- 飞行操纵……检查（左右座）
- 飞行仪表……检查（左右座）
- 简令………证实
- 襟翼调定……形态__(左右座)
- 航路总距离…，总时间…
- 使用跑道… / 跑道条件…
- 标准离港程序（SID）…
-
起始高度 …
- 复飞
- 发口令“复飞，襟翼”
- 加油门到TOGA
- 跟指引，襟翼向前收一档
- 备降场…
代码块
.md 文件中的内容：
<!-- 将某段文字显示为代码，注意包含内容中反引号转义 -->
Type `/forge tps` for server tps details
<!-- 代码块 -->
```css <!-- 此处指定代码块文本高亮语言类型 -->
*:hover{
display: none;
}
// byd谁教你这么写的
```
渲染效果：
Type /forge tps for server tps details
*:hover{
display: none;
}
// byd谁教你这么写的
分割线
.md 文件中的内容：
<!-- 几种写法等效，字符数量需≥3且行内不能有其他内容 -->
***
---
___
渲染效果：
链接
[超链接显示名](超链接地址 "超链接title")
图片
<!-- md插入图片的语法不会限制图片宽度，建议使用如下html语句插入图片，两者等效。 -->
<img class="img-fluid" src="/img/intro.webp">
扩展语法
以下语法并不受所有 markdown 应用程序支持，但在大部分 markdown 应用程序（或应用了 markdown 处理器扩展）中可用。
表格
| Syntax | Description |
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |
<!-- 单元格宽度不要求等宽，以下写法也是可行的。 -->
| Syntax | Description |
| --- | ----------- |
| Header | Title |
| Paragraph | Text |
<!-- 在标题行中的连字符的左侧，右侧或两侧添加冒号（:），将列中的文本对齐到左侧，右侧或中心。 -->
| Syntax | Description | Test Text |
| :--- | :----: | ---: |
| Header | Title | Here's this |
| Paragraph | Text | And more |
渲染输出如下：
| Syntax | Description |
|---|---|
| Header | Title |
| Paragraph | Text |
| Syntax | Description | Test Text |
|---|---|---|
| Header | Title | Here’s this |
| Paragraph | Text | And more |
脚注
在方括号[^1]内添加插入符号和标识符来创建脚注。
在括号内使用另一个插入符号和数字[^1]: My footnote.将脚注插入至文章中。
标识符可以是数字或单词，但不能包含空格或制表符。
标识符不影响渲染输出中的样式。他们只用于将脚注与内容相关联。
整合包部分客户端的命名规则为 `scex [周目号] [周目代号] [版本号].zip`[^2]。e.g. `scex 4th Astral ver1.5fix3.zip`
养老部分客户端为 `scex client [版本号] for zen.zip`[^2]。e.g. `scex client ver.1.2 for zen.zip`
[^2]: 版本号应当符合[语义化版本 2.0.0](https://semver.org/lang/zh-CN/)。
整合包部分客户端的命名规则为 scex [周目号] [周目代号] [版本号].zip1。e.g. scex 4th Astral ver1.5fix3.zip
养老部分客户端为 scex client [版本号] for zen.zip1。e.g. scex client ver.1.2 for zen.zip
任务列表
- [x] Write the press release
- [ ] Update the website
- [ ] Contact the media
- Write the press release
- Update the website
- Contact the media
特殊内容
以下内容由本站内 css 样式提供，仅适用于本站内文章应用。
高亮 markdown quote
现在可以安全地关闭计算机了
Retard Retard
PULL UP
==> Initcpio image generation successful
高亮div元素
<div class="warning">
warn div style<br>
<br>
T.O. CONFIG PARK BREAK NOT RESET
</div>
<div class="caution">
caut div style<br>
<br>
*注意前方限速 注意前方限速<br>
*红灯停车 红灯停车
</div>
<div class="approved">
appr div style<br>
<br>
TCAS STBY<br>
SPEED BREAK
</div>
<div class="tips">
tips div style<br>
<br>
MAN<br>
FLX F40
</div>
T.O. CONFIG PARK BREAK NOT RESET
*注意前方限速 注意前方限速
*红灯停车 红灯停车
TCAS STBY
SPEED BREAK
MAN
FLX F40
参考文章：
-
版本号应当符合语义化版本 2.0.0。 ↩ ↩2