markdown

markdown

什么是 markdown

Markdown 是一种轻量级的标记语言，它允许人们使用易读易写的纯文本格式编写文档，然后转换成结构化的 HTML（超文本标记语言）。它非常适合用于编写笔记、文档、博客等内容，尤其在程序员和写作爱好者中非常流行。

markdown 的好处就是，它属于文本文件，你只要通过简单的语法，就可以完成相应的排版，从而减少对你思路的打断。相较于富文本编辑器，对于你的思路和兼容性都更加有优势。

什么时候可以使用 markdown

• 编写文档：快速，清晰组织文档。
• 编写博客：本博客就是使用 markdown 编写的。
• 编写笔记：快速记录笔记，方便查阅。
• 编写任务清单：方便记录任务，查看任务进度。

语法

基本语法

（一）标题

使用#符号表示标题，#的数量表示标题级别。

# 一级标题

## 二级标题

### 三级标题

#### 四级标题

##### 五级标题

###### 六级标题

（二）文本样式

• 加粗：用**包围文本，如**加粗文本**，显示为加粗文本。
• 斜体：用*或_包围文本，如*斜体文本*或_斜体文本_，显示为斜体文本。
• 删除线：用~~包围文本，如~~删除线文本~~，显示为删除线文本。

（三）列表

• 无序列表：使用-、*或+作为列表标记。

- 项目 1
* 项目 2
- 项目 3

• 有序列表：使用数字和.作为列表标记。

  1. 项目 1
  2. 项目 2
  3. 项目 3

• 任务列表：使用- [ ]或- [x]表示任务列表。

- [ ] 未完成任务
- [x] 已完成任务

（四）引用/注解

使用>表示引用，可以嵌套使用。

> 这是一段引用
>> 这是嵌套的引用

（五）代码块

• 行内代码：使用反引号包围代码，如行内代码`。

• 代码块：使用三个反引号包围代码块，并指定语言类型。

  ```python
  def hello():
      print('Hello, Markdown!')
  

（六）链接

• 行内链接：使用[链接文本](链接地址)表示行内链接。

  [百度](https://www.baidu.com)
  

更多语法请参考 Markdown 语法说明。

个人感受

基本上，markdown 的语法非常简单，只要掌握了基本语法，就可以快速编写文档。而且 markdown 的文本文件，可以在任何地方打开，不用担心兼容性问题。

其中较为有用的是标题、列表、引用、代码块、链接几个语法，这些语法可以满足大部分的文档编写需求。以及日常记录任务、笔记等内容。