Markdown文档编写指南

Markdown 简介

Markdown 是一种轻量级标记语言,用简单易读的纯文本格式编写文档,可转换为HTML或其他格式。

特点:

  • 扩展名:.md.markdown

  • 兼容性强(GitHub、VS Code、Typora等均支持)

  • 支持HTML嵌套

基础语法

2.1 标题

# 一级标题(H1)
## 二级标题(H2)
### 三级标题(H3)
#### 四级标题(H4)
##### 五级标题(H5)
###### 六级标题(H6)

替代语法(仅H1/H2):

一级标题
=======

二级标题
-------

2.2 段落与换行

  • 段落:空一行分隔段落

  • 换行:行尾添加两个空格或<br>

2.3 文字样式

*斜体* 或 _斜体_  
**粗体** 或 __粗体__  
***粗斜体***  
~~删除线~~  
`行内代码`  

2.4 列表

无序列表:

1. 第一项
2. 第二项
   1. 子项(缩进3空格)

2.5 链接与图片

[链接文字](URL "可选标题")

![图片描述](图片URL "可选标题")

**高级用法**:
[引用链接][id]
[id]: https://example.com "标题"

2.6 引用

> 引用内容  
> 多行引用

> 嵌套引用
>> 第二层

2.7 代码块

行内代码: `code`

多行代码:

```语言(如python、javascript)
代码内容
```

或缩进4空格:

    def hello():
        print("Hello Markdown!")

2.8 分隔线

---
或
***
或
___

3. 进阶语法

3.1 表格

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

3.2 任务列表(GitHub扩展)

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

3.3 脚注

这是一个脚注示例[^note].

[^note]: 这里是脚注内容.

3.4 内嵌HTML

<div style="color:red">
  红色文字(Markdown不支持的样式)
</div>

3.5 目录(部分解析器支持)

[TOC]

4. 扩展语法(GFM/CommonMark)

4.1 GitHub Flavored Markdown (GFM)

  • 表情符号::smile: → 😄

  • 高亮:==重点== → ==重点==

  • 自动链接:https://example.com

4.2 数学公式(KaTeX)

```math
E = mc^2
```

行内公式:`$ \frac{a}{b} $`

5. 工具推荐

  1. 编辑器:
  • VS Code(+ Markdown All in One插件)

  • Typora(所见即所得)

  • Obsidian(知识管理)

  1. 在线工具:
  • Markdown Live Preview

  • Dillinger

6. 最佳实践

  1. 标题层级从H1开始依次递减

  2. 列表统一使用-符号

  3. 代码块指定语言以获得语法高亮

  4. 长表格建议用HTML实现

  5. 插入大图时使用引用链接保持可读性

示例完整文档:

# 示例文档

## 功能演示
这是一个**加粗**的文字和[链接](https://example.com)。

```python
def hello():
    print("Hello World!")
```

| 功能       | 是否支持 |
|------------|----------|
| 表格       | ✓        |
| 数学公式   | ✗        |


> 提示:学习Markdown只需10分钟!

掌握这些语法后,你可以高效编写文档、笔记、博客等内容。Markdown的灵活性和简洁性使其成为开发者和写作者的首选工具。

Built with Hugo
Theme Stack designed by Jimmy