markdown基础用法及进阶用法
·
以下是 Markdown 的基础用法及进阶用法总结,结合常用场景和示例说明:
一、基础用法
1. 标题(Headings)
用于层级结构,使用 # 表示,最多 6 级标题:
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
2. 文本格式
| 效果 | 语法 | 示例 |
|---|---|---|
| 加粗 | **内容** 或 __内容__ | 加粗文本 |
| 斜体 | *内容* 或 _内容_ | 斜体文本 |
| 加粗+斜体 | ***内容*** | 加粗斜体 |
| 删除线 | ~~内容~~ | |
| 行内代码 | `内容` | print("Hello World") |
3. 列表(Lists)
- 无序列表:使用
-、+或*开头- 项目1 - 项目2 - 子项目1 - 子项目2 - 有序列表:使用数字加点
1.开头1. 步骤1 2. 步骤2 1. 子步骤1 2. 子步骤2 - 任务列表(进阶,需支持扩展,如 GitHub Flavored Markdown)
- [x] 已完成任务 - [ ] 未完成任务
4. 链接与图片
- 链接:
- 行内链接:
[文本](URL)
示例:百度 - 引用式链接:
[文本][标签],标签定义在文末
示例:[引用链接][baidu],文末[baidu]: https://www.baidu.com
- 行内链接:
- 图片:语法类似链接,前缀加
! ![图标][icon] [icon]: /path/to/icon.png "图标" # 引用式图片定义
5. 引用(Blockquotes)
用于引用文本,使用 > 开头,可嵌套:
> 第一层引用
> > 第二层引用
> > > 第三层引用
6. 代码块
- 行内代码:用
`包裹,如`function() {}` - 代码块:用三个反引号 `` `````包裹,可指定语言(语法高亮)
def hello(): print("Hello Markdown!") - 缩进代码块:每行开头加 4 个空格或 1 个制表符(传统 Markdown 方式)。
二、进阶用法
1. 表格(Tables)
使用 | 分隔列,--- 分隔表头和内容,支持对齐设置:
| 标题1 | 标题2 | 标题3 |
|-------|---------|---------|
| 左对齐 | 居中对齐 | 右对齐 |
| :---- | :------: | ----: |
| 内容1 | 内容2 | 内容3 |
2. 分隔线(Horizontal Rules)
使用三个或更多 -、* 或 _ 生成:
---
***
___
3. 脚注(Footnotes)
用于添加注释,语法:[^标签] 引用,文末 [^标签]: 注释内容
这是一个脚注引用[^note]。
[^note]: 脚注内容可以是任意文本。
4. 数学公式(需支持 LaTeX 语法,如 Markdown Extra 或 KaTeX)
- 行内公式:用
$包裹,如$E=mc^2$ - 块级公式:用
$$包裹(或\begin{equation}...\end{equation})$$ \sum_{i=1}^n i = \frac{n(n+1)}{2} $$
5. 自定义样式(需支持 HTML 或 CSS 扩展)
- 直接嵌入 HTML 标签(Markdown 兼容 HTML):
<div style="color: red; font-size: 1.2em;">红色文本</div> - 针对特定解析器(如 Docusaurus、GitBook),可通过 CSS 类自定义样式:
{::nomarkdown} <div className="custom-box">自定义样式区域</div> {:/nomarkdown}
6. 链接引用格式(Reference Links)
将链接统一放在文末,避免重复书写 URL,提升可读性:
这是一个长链接示例[1],另一个链接示例[2]。
[1]: https://example.com/long-url
[2]: https://example.com/another-url
7. 转义字符
当需要显示原始符号(如 #、*、` 等),在前面加反斜杠 \:
\# 显示井号
\* 显示星号
8. 折叠内容(需特定解析器支持,如 Markdown-it 插件)
<details>
<summary>点击展开</summary>
隐藏的内容...
</details>
9. 高级扩展(不同平台特性)
- GitHub Flavored Markdown (GFM):支持任务列表、表格、行内公式(通过 KaTeX)、自动链接等。
- Pandoc Markdown:支持更多格式(如 LaTeX 宏、YAML 元数据)、交叉引用(
@fig:fig1)。 - Markdown Extra:支持脚注、表格、缩写等。
三、最佳实践
- 保持简洁:优先使用基础语法,复杂格式通过 HTML 或扩展语法补充。
- 兼容性:根据使用场景(如 GitHub、博客、文档工具)选择支持的语法子集。
- 工具推荐:
- 编辑器:Typora(实时预览)、VS Code(插件丰富)、Obsidian(笔记场景)。
- 转换工具:Pandoc(格式转换)、Markdown Preview Enhanced(VS Code 插件)。
Markdown 以轻量易读为核心,进阶用法需结合具体工具或平台的扩展能力。掌握基础后,可根据需求学习特定场景的高级功能(如学术写作中的公式、技术文档中的代码块规范)。
更多推荐
所有评论(0)