# GFM (GitHub Flavored Markdown) 完全示例文档 ## 目录 - [基础语法](#基础语法) - [扩展语法](#扩展语法) - [GitHub专属功能](#github专属功能) - [高级功能](#高级功能) --- ## 基础语法 ### 标题 # H1 ## H2 ### H3 #### H4 ##### H5 ###### H6 ### 文本样式 **加粗文本** 或 __加粗文本__ *斜体文本* 或 _斜体文本_ ***粗斜体文本*** 或 ___粗斜体文本___ ~~删除线文本~~ ==高亮文本== (部分GFM支持) ### 引用 > 这是引用文本 > > 多行引用 > > > 嵌套引用 > > 引用中可以使用**加粗**、*斜体*等样式 ### 列表 #### 无序列表 - 项目一 - 项目二 - 子项目一 - 子项目二 - 三级子项目 - 项目三 #### 有序列表 1. 第一项 2. 第二项 1. 子项一 2. 子项二 3. 第三项 #### 任务列表 - [ ] 未完成任务 - [x] 已完成任务 - [x] 任务一 - [ ] 子任务 - [ ] 任务二 #### 混合列表 1. 有序项 - 无序子项 - [x] 任务子项 2. 另一有序项 ### 链接 [内联链接](https://github.com) [带标题的链接](https://github.com "GitHub主页") [引用式链接][1] [相对路径链接](../README.md) [1]: https://github.com 自动链接: ### 图片 ![GitHub Logo](https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png "GitHub标志") 带尺寸的图片(HTML): ### 代码 行内代码:使用 `git status` 命令 代码块: ```python def hello_world(): print("Hello, World!") return True ``` ```javascript const message = "Hello World"; console.log(message); ``` ```markdown # 这是 markdown 代码块 **粗体** 和 *斜体* 测试 - 列表项 [链接](https://example.com) ``` ### 表格 | 标题左对齐 | 标题居中对齐 | 标题右对齐 | | :--- | :---: | ---: | | 内容左 | 内容中 | 内容右 | | 长文本左对齐 | 居中内容 | 右对齐数字 | | **粗体** | *斜体* | `代码` | ### 分隔线 --- *** ___ --- ## 扩展语法 ### 脚注 这是一段带有脚注的文本[^1]。 这里是另一个脚注[^2]。 [^1]: 这是第一个脚注的内容。 [^2]: 这是第二个脚注的内容,可以包含**格式**和`代码`。 ### 定义列表 术语一 : 定义一 术语二 : 定义二 : 第二个定义 ### 缩写 HTML 规范由 W3C 维护。 *[HTML]: HyperText Markup Language *[W3C]: World Wide Web Consortium ### 表情符号 :smile: :heart: :+1: :-1: :rocket: 完整列表见 [GitHub Emoji API](https://api.github.com/emojis) ### 自动链接转换 https://github.com user@example.com ### 删除线增强 ~单删除线~ ~~双删除线~~ ### 上标和下标 H~2~O 是水分子 E = mc^2^ ## GitHub专属功能 ### 提及和引用 @username - 提及用户 #123 - 引用issue或PR user/repo#456 - 引用其他仓库的issue ### 任务列表(在issue/PR中) - [x] 已完成 - [ ] 未完成 - [x] 嵌套已完成 - [ ] 嵌套未完成 ### 表格对齐增强 | 列1 | 列2 | 列3 | |-----|-----|-----| | a | b | c | ### 代码高亮 ```diff - 删除的代码 + 新增的代码 ``` ```bash #!/bin/bash echo "Hello" ``` ### 数学公式(部分支持) 行内公式:$E = mc^2$ 块公式: $$ \begin{aligned} f(x) &= \int_{-\infty}^\infty \hat f(\xi)\,e^{2 \pi i \xi x} \, d\xi \\ \frac{\partial u}{\partial t} = \alpha \nabla^2 u \end{aligned} $$ ## 高级功能 ### 表格中的对齐和格式 | 功能 | 支持情况 | 备注 | |------|:---------:|------| | **粗体** | ✓ | 支持 | | *斜体* | ✓ | 支持 | | ~~删除线~~ | ✓ | 支持 | | `内联代码` | ✓ | 支持 | | 链接 | ✓ | [示例](https://github.com) | | 图片 | ⚠️ | 可能受限制 | | 列表 | ✓ | 支持 | ### 嵌套元素 > #### 引用中的标题 > > 1. 引用中的有序列表 > 2. 第二项 > > - 引用中的无序列表 > - 另一项 > > `代码` 和 **粗体** 也可以使用 ### 细节和摘要
点击展开详细信息 这里是被隐藏的内容。 - 列表项1 - 列表项2 ```python print("展开后的代码") ```
带格式的标题 更多内容...
### 注释(不会被渲染) ### 目录(使用锚点) 实际上,GFM支持自动为标题生成锚点,例如: - [基础语法](#基础语法) - [扩展语法](#扩展语法) ### 键盘键 按 Ctrl + C 复制 按 + Q 退出 ### 进度条 原生Markdown不支持,但可以使用HTML:
75%
### 警告/提示框 > **注意**: 这是一个提示框 > > 使用引用块创建简单的提示信息。 > **警告**: 重要提醒 > > 这是警告内容。 ### 图表(通过Mermaid) ```mermaid graph TD; A-->B; A-->C; B-->D; C-->D; ``` ```mermaid sequenceDiagram participant A as 用户 participant B as 服务器 A->>B: 请求数据 B-->>A: 返回数据 ``` --- ## 总结 这是GitHub Flavored Markdown的完整功能演示。GFM在标准Markdown基础上增加了许多实用功能,使得在GitHub平台上的文档编写更加便捷和强大。 **最佳实践提示:** 1. 保持一致的标题层级 2. 为链接添加有意义的描述 3. 在表格中使用对齐提升可读性 4. 适当使用代码块和语法高亮 5. 利用任务列表跟踪进度 ### 许可证 此文档内容遵循 [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) 许可 *最后更新: $(date)*