目录

  1. 什么是 Markdown?
  2. 基本语法
  3. 进阶语法
  4. 编辑器推荐
  5. 最佳实践

什么是 Markdown?

Markdown 是一种轻量级标记语言,创建于 2004 年,目标是让书写的格式化文本尽可能易读易写。它使用简单的符号来实现格式化,可以轻松转换成 HTML 或其他格式。无论是写博客、文档还是笔记,Markdown 都是一个理想的选择。

基本语法

1. 标题

Markdown 支持六级标题,使用 # 符号表示:

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

2. 文本格式化

*斜体文本*_斜体文本_
**粗体文本**__粗体文本__
***粗斜体文本***___粗斜体文本___
~~删除线文本~~

实际效果:
斜体文本
粗体文本
粗斜体文本
删除线文本

3. 列表

无序列表使用 -*+

- 项目1
- 项目2
  - 子项目2.1
  - 子项目2.2

有序列表使用数字加点:

1. 第一项
2. 第二项
   1. 子项2.1
   2. 子项2.2

4. 链接和图片

链接格式:

[链接文字](URL "可选标题")
例如:[GitHub](https://github.com "访问GitHub")

图片格式:

![替代文字](图片URL "可选标题")
例如:![logo](https://example.com/logo.png "Logo")

进阶语法

1. 表格

| 表头1 | 表头2 | 表头3 |
|-------|--------|-------|
| 内容1 | 内容2 | 内容3 |
| 行2内容1 | 行2内容2 | 行2内容3 |

对齐方式:

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

2. 代码块

行内代码使用单反引号:

使用 `print("Hello World")` 输出文本

代码块使用三个反引号,可以指定语言:

```python
def hello_world():
    print("Hello, World!")
```

3. 引用

> 这是一个引用
> 
> 这是引用的第二段
>> 这是嵌套引用

实际效果:

这是一个引用

这是引用的第二段

这是嵌套引用

4. 分隔线

使用三个或更多的 -*_

---
***
___

编辑器推荐

  1. Visual Studio Code - 配合 Markdown 插件使用
  2. Typora - 所见即所得的 Markdown 编辑器
  3. MarkText - 开源的 Markdown 编辑器
  4. Obsidian - 适合知识管理的 Markdown 编辑器

最佳实践

  1. 保持一致性

    • 选择一种列表符号(-*+)并始终使用它
    • 保持标题层级的逻辑性,不要跳过层级
  2. 空行的使用

    • 在段落之间使用空行
    • 在标题前后使用空行
    • 在列表项中包含多个段落时,使用缩进和空行
  3. 文件组织

    • 为长文档添加目录
    • 使用有意义的标题
    • 适当使用分隔线划分内容
  4. 格式化建议

    • 链接文字要具有描述性
    • 图片要添加有意义的替代文字
    • 代码块要指定语言以获得语法高亮

记住,Markdown 的核心理念是简洁易读。在写作时,应该始终以提高可读性为目标,避免过度使用格式化元素。通过合理运用这些语法规则,你可以创建出既美观又易于维护的文档。