Markdown 是一种轻量级标记语言,使用纯文本格式编写,可转换为结构化的 HTML。它简单易学,广泛应用于技术文档、博客、笔记和 README 文件。

目录


标题

使用 1-6 个 # 创建标题:

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

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

文本格式

**粗体文本**  
*斜体文本*  
~~删除线文本~~  
<mark>高亮文本</mark>
`行内代码`  
H<sub>2</sub>O  
E = mc<sup>2</sup>

粗体文本
斜体文本
删除线文本
高亮文本
行内代码
H2O
E = mc2


列表

无序列表

- 苹果
- 香蕉
  - 进口香蕉
  - 本地香蕉
- 橙子
  • 苹果
  • 香蕉
    • 进口香蕉
    • 本地香蕉
  • 橙子

有序列表

1. 第一步:准备材料
2. 第二步:混合原料
3. 第三步:烘烤
   1. 预热烤箱
   2. 放入模具
4. 第四步:装饰
  1. 第一步:准备材料
  2. 第二步:混合原料
  3. 第三步:烘烤
    1. 预热烤箱
    2. 放入模具
  4. 第四步:装饰

任务列表

- [x] 完成项目提案
- [ ] 编写代码文档
- [ ] 测试功能模块
  • 完成项目提案
  • 编写代码文档
  • 测试功能模块

链接与图片

基本链接

[GitHub](https://github.com)

GitHub

引用链接

学习更多 [Markdown 语法][1]

[1]: https://www.markdownguide.org

学习更多 Markdown 语法

图片

![Markdown 标志](https://markdown-here.com/img/icon256.png)

Markdown 标志

图片链接

[![GitHub 标志](https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png)](https://github.com)

GitHub 标志


代码

行内代码

使用 `console.log()` 输出信息

使用 console.log() 输出信息

代码块

```
javascript
function greet(name) {
  console.log(`Hello, ${name}!`);
}
greet("World");
```
function greet(name) {
  console.log(`Hello, ${name}!`);
}
greet("World");

语法高亮

```python
def fibonacci(n):
    if n <= 1:
        return n
    else:
        return fibonacci(n-1) + fibonacci(n-2)
```
def fibonacci(n):
    if n <= 1:
        return n
    else:
        return fibonacci(n-1) + fibonacci(n-2)

表格

| 语言       | 年份 | 类型         | 流行度 |
|------------|------|--------------|--------|
| JavaScript | 1995 | 解释型       | ★★★★★  |
| Python     | 1991 | 解释型       | ★★★★☆  |
| Java       | 1995 | 编译型       | ★★★★☆  |
| C++        | 1985 | 编译型       | ★★★☆☆  |
语言 年份 类型 流行度
JavaScript 1995 解释型 ★★★★★
Python 1991 解释型 ★★★★☆
Java 1995 编译型 ★★★★☆
C++ 1985 编译型 ★★★☆☆

对齐方式

| 左对齐      | 居中        | 右对齐       |
|:------------|:-----------:|-------------:|
| 内容        | 内容        | 内容         |
| 文本        | 文本        | 文本         |
左对齐 居中 右对齐
内容 内容 内容
文本 文本 文本

引用

> 技术本身不是目的,而是解决问题的手段。
> 
> — 匿名开发者

技术本身不是目的,而是解决问题的手段。

— 匿名开发者

嵌套引用

> 主要观点
> > 补充说明
> 
> 结论部分

主要观点

补充说明

结论部分


分隔线

三个或更多连字符:

---

星号:

***

下划线:

___

三个或更多连字符:


星号:


下划线:



HTML 集成

<details>
<summary>点击查看高级技巧</summary>

### 折叠内容
这里是被折叠的内容...

- 技巧一:使用表情符号 :rocket:
- 技巧二:添加脚注[^1]
- 技巧三:嵌入数学公式 $E=mc^2$

</details>

键盘快捷键:<kbd>Ctrl</kbd>+<kbd>C</kbd> 复制,<kbd>Ctrl</kbd>+<kbd>V</kbd> 粘贴
点击查看高级技巧

折叠内容

这里是被折叠的内容…

  • 技巧一:使用表情符号 :rocket:
  • 技巧二:添加脚注1
  • 技巧三:嵌入数学公式 $E=mc^2$

键盘快捷键:Ctrl+C 复制,Ctrl+V 粘贴


高级技巧

脚注

Markdown 由 John Gruber 创建[^1]

[^1]: 2004 年首次发布

Markdown 由 John Gruber 创建1

表情符号

常用表情::smile: :heart: :rocket: :+1: :bulb:

常用表情::smile: :heart: :rocket: :+1: :bulb:

自动链接

访问 https://www.example.com 或联系 email@example.com

访问 https://www.example.com 或联系 email@example.com

数学公式(需支持 LaTeX)

勾股定理:$a^2 + b^2 = c^2$

积分公式:
$$
\int_{a}^{b} x^2 dx = \left[ \frac{x^3}{3} \right]_a^b
$$

勾股定理:$a^2 + b^2 = c^2$

积分公式: $$ \int_{a}^{b} x^2 dx = \left[ \frac{x^3}{3} \right]_a^b $$

图表(Mermaid 支持)

```mermaid
flowchart TD
    A[开始] --> B{决策}
    B -->|条件1| C[结果1]
    B -->|条件2| D[结果2]
    C --> E[结束]
    D --> E
```
flowchart TD
    A[开始] --> B{决策}
    B -->|条件1| C[结果1]
    B -->|条件2| D[结果2]
    C --> E[结束]
    D --> E

最佳实践

保持一致性: 在整个文档中使用相同的格式风格

适度使用: 避免过度使用格式影响可读性

分段合理: 使用空行分隔不同内容区块

版本控制: Markdown 完美兼容 Git

工具利用:

  • VS Code(实时预览)

  • Typora(所见即所得)

  • Markdown Here(邮件格式化)


资源推荐

Markdown 官方指南

Markdown 教程

GitHub Markdown 参考

开始使用 Markdown 吧! 它是一种简单却强大的工具,能显著提升你的文档编写效率和专业性。练习是最好的学习方法,尝试用 Markdown 编写你的下一个项目文档或技术笔记。

参考:Markdown 基本语法

最后更新:2025年8月16日


  1. 2004 年首次发布 ↩︎ ↩︎