Markdown从入门到精通（四）：高级技巧——专业文档必备

张涛酱107456
3 阅读2分钟

让你的文档更像专业技术文档。

一、任务列表

1.1 基本语法

- [ ] 未完成的任务
- [x] 已完成的任务

渲染效果：

  • 未完成的任务
  • 已完成的任务

1.2 使用场景

项目README：

## 开发计划

- [x] 基础框架搭建
- [x] 用户认证模块
- [ ] 数据分析模块
- [ ] 性能优化
- [ ] 文档完善

会议记录：

## 待办事项

- [x] 确定技术方案
- [x] 分配任务
- [ ] 完成原型设计
- [ ] 代码评审

1.3 注意事项

注意点说明
支持平台GitHub、GitLab、部分Markdown编辑器
格式要求[ ] 中间要有空格
嵌套可以在列表中嵌套使用

二、脚注

2.1 基本语法

这是一个需要注释的内容[^1]。

[^1]: 这是脚注的内容。

渲染效果：

这是一个需要注释的内容1。

2.2 使用场景

学术文档：

根据研究数据[^study1]，AI技术正在快速发展。

[^study1]: 来源：2026年AI发展报告，第15页。

技术文档：

Spring AI 2.0.0-M3[^release] 于2026年3月发布。

[^release]: https://spring.io/blog/2026/03/17/spring-ai-2-0-0-m3

2.3 多处引用

第一处引用[^ref]
第二处引用[^ref]

[^ref]: 同一个脚注可以被多次引用

三、目录

3.1 自动生成目录

GitHub/GitLab支持：

[[toc]]

或

[TOC]

3.2 手动目录

## 目录

- [一、简介](#一简介)
- [二、安装](#二安装)
- [三、使用](#三使用)

锚点规则：

  • 标题转为小写
  • 空格变为 -
  • 特殊字符移除

示例：

标题锚点
## 一、简介#一简介
## Hello World#hello-world
## FAQ 常见问题#faq-常见问题

四、数学公式

4.1 行内公式

质能方程 $E = mc^2$ 是物理学的基础。

渲染效果：

质能方程 E=mc2E = mc^2 是物理学的基础。

4.2 块级公式

$$
\frac{-b \pm \sqrt{b^2 - 4ac}}{2a}
$$

渲染效果：

−b±b2−4ac2a\frac{-b \pm \sqrt{b^2 - 4ac}}{2a}

4.3 常用公式示例

求和公式：

$$
\sum_{i=1}^{n} x_i
$$

积分公式：

$$
\int_{0}^{\infty} e^{-x^2} dx = \frac{\sqrt{\pi}}{2}
$$

矩阵：

$$
\begin{bmatrix}
a & b \\
c & d
\end{bmatrix}
$$

4.4 支持情况

平台支持
GitHub✅
GitLab✅
掘金✅
Typora✅
Obsidian✅
纯Markdown解析器❌（需要插件）

五、定义列表

5.1 语法（部分平台支持）

术语1
: 定义1

术语2
: 定义2

渲染效果：

术语1 : 定义1

术语2 : 定义2

5.2 使用HTML替代

标准Markdown不支持时，可用HTML：

<dl>
  <dt>Java</dt>
  <dd>一种面向对象的编程语言</dd>

  <dt>Python</dt>
  <dd>一种解释型编程语言</dd>
</dl>

六、缩写

6.1 语法（部分平台支持）

*[HTML]: Hyper Text Markup Language
*[CSS]: Cascading Style Sheets

HTML和CSS是前端开发的基础。

渲染效果： 鼠标悬停时显示完整解释。

6.2 适用场景

技术文档中解释专业术语。

七、高亮标记

7.1 语法

这是==高亮标记==的文字。

渲染效果：

这是==高亮标记==的文字。

7.2 支持情况

平台支持
Obsidian✅
Typora✅
GitHub❌
标准❌

7.3 替代方案

使用HTML：

这是<mark>高亮标记</mark>的文字。

八、上下标

8.1 语法

H~2~O 是水
2^10^ = 1024

渲染效果：

H2O 是水 2^10^ = 1024

8.2 使用公式替代

更通用的方式：

$H_2O$ 是水
$2^{10} = 1024$

九、注释

9.1 HTML注释

<!-- 这是注释，不会显示 -->

这是可见的内容。

9.2 使用场景

  • 隐藏未完成的内容
  • 添加编辑备注
  • 记录修改历史

十、综合示例

# 技术方案文档

## 目录

- [一、背景](#一背景)
- [二、方案](#二方案)
- [三、计划](#三计划)

## 一、背景

本项目旨在解决XX问题[^problem]。

[^problem]: 问题来源于2026年第一季度的用户反馈。

## 二、方案

采用**Spring Boot 4.0**[^spring]作为主框架。

核心算法：

$$
O(n \log n)
$$

### 技术栈

| 技术 | 版本 | 说明 |
|------|------|------|
| Java | 21 | 主语言 |
| Spring Boot | 4.0.4 | 框架 |

## 三、计划

- [x] 需求分析
- [x] 方案设计
- [ ] 开发实现
- [ ] 测试验收

---

*文档版本：v1.0*
*更新日期：2026-03-24*

十一、语法速查表

功能语法支持度
任务列表- [ ] / - [x]GitHub/部分编辑器
脚注[^id]: 内容大部分平台
目录[TOC] / [[toc]]部分平台
公式$公式$ / $$公式$$大部分平台
高亮==文字==Obsidian/Typora
上下标~下标~ / ^上标^部分平台
注释<!-- 注释 -->通用

十二、平台兼容性

12.1 高兼容性功能

这些功能几乎所有平台都支持：

  • 标题、段落、强调
  • 列表、引用
  • 链接、图片
  • 表格、代码块

12.2 需确认的功能

这些功能需要确认平台支持：

  • 任务列表
  • 脚注
  • 数学公式
  • 目录自动生成
  • 高亮标记
  • 定义列表

12.3 兼容性建议

建议说明
优先使用基础语法兼容性最好
高级功能做降级不支持时用替代方案
测试目标平台发布前预览效果

十三、总结

要点内容
任务列表项目管理和待办事项
脚注注释和引用来源
目录长文档导航
公式学术和技术文档
注意高级功能需确认平台支持

Footnotes

  1. 这是脚注的内容。 ↩

avatar
文章
阅读
粉丝