Markdown 是用纯文本符号组织文章的写作格式。记住少量规则就能写出结构清楚、便于修改的内容,示例可以直接复制到本站后台编辑器预览。

三条基本规则

  1. 用符号表示结构:# 是标题,- 是列表;
  2. 大多数语法要在符号和正文之间留空格;
  3. 不同内容块之间空一行。

标题

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

一篇文章通常只有一个一级标题,正文从二级开始。标题承担的是文章结构,不要为了字大而跳级。

段落与换行

段落之间空一行。只想段内换行时,在上一行末尾加两个空格再回车。强行换行只适合诗句、地址这类内容,优先用分段表达意思。

强调与高亮

*斜体*  **加粗**  ***加粗倾斜***  ~~删除线~~

本站扩展写法:<u>下划线</u> → 下划线,<mark>重点</mark> → 重点,H~2~O → H2O,x^2^ → x2。强调要有节制,一段话里重点太多就没有重点。

列表

- 无序列表项
1. 有序列表项
- 父项
  - 子项(缩进两个空格)
- [x] 已完成任务
- [ ] 未完成任务

本站兼容 -[x]、-[] 这类省略空格的写法,但建议始终用标准格式,方便迁移到其他编辑器。

引用与分隔线

行首 > 表示引用,引用内可以继续用其他语法;三个以上连字符 --- 是水平分隔线,适合分开关系较远的内容。

链接与图片

[OpenAI](https://openai.com)
[OpenAI](https://openai.com "悬停提示")
![替代文字](https://example.com/moon.jpg)

替代文字在图片加载失败时显示,也方便屏幕阅读器用户,不要省略。本地文章可以引用同文件夹下的图片(如 ./images/shanshui.jpg),运行同步脚本时会自动上传并替换为网站地址;图片文件不存在时原路径保留,发布前需检查。

代码

行内代码用一对反引号:`node sync.js`。多行代码用三个反引号包裹,开头标注语言名可语法高亮:

```javascript
function greet(name) {
  return `你好,${name}!`;
}
```

常用语言名:javascript、html、css、json、bash、python。开始和结束标记必须成对,代码块内部的空格换行会被保留。

表格

| 语法 | 作用 |
| --- | --- |
| `# 标题` | 创建标题 |
| `**文字**` | 加粗 |

冒号控制对齐:| :--- | 左对齐、| :---: | 居中、| ---: | 右对齐。表格适合简短的规则信息,每个单元格一大段文字时改用小标题加列表。

脚注

正文写 [^1],文末用同一编号补充说明,本站会自动收集到文章末尾并生成返回链接。脚注适合解释术语、补充出处,不放主要内容。

本站扩展语法

写法 用途 示例
<u>文字</u> 下划线 重点
<mark>文字</mark> 高亮 注意
^文字^ 上标 x2
~文字~ 下标 H2O
:smile: Emoji 简写 😄
术语 换行 : 解释 定义列表 见下
Markdown
: 一种用纯文本符号组织文章的写作格式。

扩展语法只在支持它的编辑器生效,复制到其他平台前先预览一次。

文章模板

# 文章标题

用一两句话说明这篇文章要解决什么问题。

## 一、背景

## 二、主要内容
- 要点一
- 要点二

## 三、示例

## 四、总结

最容易出错的七个地方

  1. 标题 # 后没有空格;
  2. 列表符号后没有空格(-项目 应为 - 项目);
  3. 任务列表方括号内漏空格;
  4. 代码块只写了开始、忘了结束标记;
  5. 图片路径或文件名大小写不一致;
  6. <u> 标签写得不完整,本站推荐 <u>下划线</u>;
  7. 一级标题太多,目录层级混乱。

Markdown 语法并不难,先用好标题、段落、列表和代码块,再逐步加入链接、图片和表格就够了。想看视频版的可以参考:Markdown 基本语法视频。