示例索引
本目录包含与教程配套的 Markdown 示例文件,可独立使用和练习。
目录结构
examples/
├── syntax/ # 语法练习示例
├── mermaid/ # Mermaid 图表示例
└── templates/ # 实用模板(可直接复用)语法练习
| 文件 | 说明 | 对应章节 |
|---|---|---|
| basic-syntax-demo.md | 标题、段落、文本格式练习 | 第 2 章 |
| list-demo.md | 无序/有序/任务列表练习 | 第 3 章 |
| table-demo.md | 表格创建与对齐练习 | 第 7 章 |
| code-block-demo.md | 代码块与语法高亮练习 | 第 6 章 |
Mermaid 图表示例
| 文件 | 说明 | 对应章节 |
|---|---|---|
| flowchart.md | 流程图示例 | 第 10 章 |
| sequence-diagram.md | 时序图示例 | 第 10 章 |
| gantt-chart.md | 甘特图示例 | 第 10 章 |
| class-diagram.md | 类图示例 | 第 10 章 |
实用模板
| 文件 | 说明 | 对应章节 |
|---|---|---|
| github-readme-template.md | GitHub README 模板 | 第 13 章 |
| project-doc-template.md | 项目文档结构模板 | 第 13 章 |
| blog-post-template.md | 技术博客文章模板 | 第 13 章 |
| api-doc-template.md | API 文档模板 | 第 13 章 |
使用方式
- 阅读对应章节
- 打开
examples/中的示例文件查看完整写法 - 将
templates/中的模板复制到你的项目中使用