Markdown 详细语法教程

Markdown 是一种轻量级标记语言,使用简单的语法实现文本格式化。以下是完整的 Markdown 语法指南。

1. 基本语法

1.1 标题

# 一级标题

## 二级标题

### 三级标题

#### 四级标题

##### 五级标题

###### 六级标题

1.2 段落与换行

  • 段落:空一行分隔段落
  • 换行:行尾添加两个空格或<br>标签
    这是第一段(行尾有2个空格)  
    这是同一段的换行
    这是新段落
    

1.3 强调

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

1.4 列表

无序列表

- 项目1
- 项目2
  - 子项目1
  - 子项目2
* 另一种符号
+ 第三种符号

有序列表

1. 第一项
2. 第二项
   1. 子项1
   2. 子项2
3. 第三项

任务列表

- [x] 完成作业
- [ ] 购买食材
- [ ] 准备晚餐

1.5 分隔线


---
或
***
或
___

2. 链接与图片

2.1 链接

[显示文本](URL "可选标题")
<https://example.com> - 自动链接
[参考式链接][id]
[id]: https://example.com "可选标题"

2.2 图片

![替代文本](图片URL "可选标题")
![参考式图片][logo]
[logo]: /path/to/img.jpg "Logo标题"

3. 代码相关

3.1 行内代码

使用 `printf()` 函数

3.2 代码块

普通代码块

```语言
代码内容

#### 缩进代码块
```markdown
    每行缩进4个空格或1个制表符
    第二行代码

4. 表格

| 左对齐 | 居中对齐 | 右对齐 |
|:-------|:-------:|-------:|
| 数据1  | 数据2   | 数据3  |
| 数据4  | 数据5   | 数据6  |

5. 引用

> 这是引用内容
> 可以多行使用
>
> > 嵌套引用
> 
> - 引用中使用列表
> - 第二项

6. 高级语法

6.1 内嵌HTML

<details>
<summary>点击展开</summary>
隐藏的内容
</details>

6.2 脚注

这是一个脚注的例子[^note]
[^note]: 这里是脚注内容

6.3 定义列表

术语1
: 定义1
术语2
: 定义2
: 第二个定义

6.4 表情符号

:smile: :heart: :rocket:

7. 扩展语法(GitHub Flavored Markdown)

7.1 表格增强

| Command | Description |
| --- | --- |
| git status | List all new or modified files |
| git diff | Show file differences |

7.2 任务列表

- [x] #739
- [ ] https://github.com/octo-org/octo-repo/issues/740
- [ ] Add delight to the experience

7.3 高亮

==高亮文本==

7.4 自动链接

https://example.com

8. 特殊字符转义

\* 转义星号
\# 转义井号
\\ 反斜线

9. 最佳实践

  1. 一致性:在整个文档中使用相同的格式风格
  2. 可读性:即使未渲染也应易于阅读
  3. 适度使用HTML:仅在必要时使用HTML
  4. 版本控制友好:每行不超过80个字符
  5. 注释:使用HTML注释<!-- 注释内容 -->

10. 常用工具

  • 编辑器:VS Code、Typora、Obsidian
  • 在线编辑器:StackEdit、Dillinger
  • 预览工具:大多数现代IDE都支持Markdown预览
  • 转换工具:Pandoc(转换为PDF/Word等格式) Markdown因其简洁性和通用性,已成为技术文档、博客和笔记的首选格式。掌握这些语法后,您可以高效地创建结构良好的文档。









results matching ""

    No results matching ""