每天都在写 Markdown,但大多数人只用标题、加粗、代码块这老三样。今天整理 10 个不常见但极其实用的语法,看完直接贴进你的 README、文档和博客里用。
01 任务列表:README 里的进度追踪器
## 开发计划
- [x] 核心渲染逻辑
- [x] 深色主题
- [ ] 支持导出 PDF
- [ ] 多标签页
渲染出来是带勾选框的列表。GitHub、GitLab、掘金都支持,用它管理项目 TODO 比表格直观得多。
02 diff 代码块:在文档里高亮代码变更
```diff
- const port = 8080;
+ const port = 3000;
const host = 'localhost';
```
代码块语言标记写成 diff,+ 行变绿、- 行变红。写升级指南、重构对比、Changelog 时效果拔群,比截图清晰多了。
03 折叠区块:把长内容收起来
<details>
<summary>点击展开完整配置</summary>
```yaml
server:
port: 3000
host: 127.0.0.1
```
注意:<summary> 标签和内容之间要空一行,否则内部的 Markdown 不会被渲染。FAQ、超长代码、安装步骤都适合折叠,读者想看再展开,页面瞬间清爽。
04 键盘按键:kbd 标签
按 <kbd>Ctrl</kbd> + <kbd>E</kbd> 快速打开编辑器
渲染出来是带边框的按键样式,写快捷键文档时专业感拉满,比「Ctrl加E」这种写法优雅十倍。
05 引用式链接:正文不再又臭又长
具体 API 见 [官方文档][rust-docs],[Rust 中文社区][rust-cn] 也有中文教程。
[rust-docs]: https://doc.rust-lang.org/std/
[rust-cn]: https://rustlang-cn.org
链接定义统一放在文末,正文干干净净;同一个链接可以复用多次,改 URL 只用改一处。写长文时,这是最能提升源码可读性的语法。
06 脚注:正文的文献引用
地球是圆的[^shape]。
[^shape]: 参见牛顿《自然哲学的数学原理》。
渲染后正文中出现上标数字,解释内容显示在页面底部。写需要注明出处、补充说明的技术文特别合适(GitHub 支持,掘金部分支持)。
07 表格对齐与转义
| 命令 | 作用 | 快捷键 |
|:-----|:----:|------:|
| mdview | 预览文件 | `Ctrl+O` |
第二行冒号的位置控制对齐::--- 左对齐、:---: 居中、---:右对齐。单元格内容里想显示竖线|,写 |` 即可。
08 尖括号自动链接
官网:<https://rust-lang.org>
比 [text](url) 短,还能让读者看到真实 URL。在评论、Issue 这类不适合写完整链接语法的地方特别方便。
09 Mermaid:在 Markdown 里画图
```mermaid
graph LR
A[打开 .md 文件] --> B{解析渲染}
B --> C[实时预览]
B --> D[导出 PDF]
```
流程图、时序图、甘特图、饼图都能画,GitHub、GitLab、Typora 原生渲染。从此画架构图不用开第二个软件。
10 换行的隐藏规则
第一行(末尾两个空格)
第二行
Markdown 里单个回车不换行,两行会被合并成一段。行尾补两个空格(或一个 \)再回车,才是同段落内的软换行。很多人抱怨「写出来全粘成一坨」,十有八九是这个原因。
总结
| 技巧 | 一句话场景 |
|---|---|
| 任务列表 | 项目 TODO |
| diff 代码块 | 变更说明 |
| 折叠区块 | FAQ、长代码 |
| kbd 按键 | 快捷键文档 |
| 引用式链接 | 长文、多复用链接 |
| 脚注 | 引用出处 |
| 表格对齐 | 参数表 |
| 尖括号链接 | 快速贴 URL |
| Mermaid | 架构图、流程图 |
| 两个空格换行 | 诗歌、地址排版 |
彩蛋:这些语法写完去哪预览?
这些扩展语法在不同平台的支持程度不一样,发出去之前最好先本地预览一遍。顺手安利一个我写的小工具 mdview:双击任意 .md 文件就能实时预览,支持深色主题、目录导航、导出 PDF,纯本地运行不上传文件——写完文章先看一眼效果再发,告别「发出去才发现没渲染」的尴尬。
如果这篇对你有帮助,点个赞就是对我最大的鼓励,关注我,后续会持续分享开发工具和效率技巧。