扩展语法 / 围栏代码块
围栏代码块
当你需要放一段真正会被别人复制执行的命令、配置或示例代码时,围栏代码块比缩进块更清楚,也更容易附带语法高亮。
基本语法
使用三个反引号包裹代码块,后面可以直接写语言名:
```bash
npm install
npm run dev
npm run build
``` 为什么要写语言标识
语言标识会影响高亮和读者理解。写命令用 bash,配置常用 yaml 或 json,示例 Markdown 可以写成 md。
bash适合命令行步骤和部署脚本yaml适合 GitHub Actions、站点配置等片段json适合接口返回或配置对象md适合示范 Markdown 本身
无语言标识符
如果你只是想保留原始文本格式,也可以省略语言名:
```
dist/
index.html
assets/
search-index.json
``` 写作建议
- 示例最好能直接复制执行,少放“Hello, World!”这类跟场景没关系的占位代码。
- 如果一段命令有前置条件,代码块上面先写清“在哪执行”“执行后会发生什么”。
- 长代码块尽量只保留当前页面要讲的重点,避免把读者带进无关细节。
评论
评论区暂未开放。
需要先为这个仓库启用 GitHub Discussions,并完成 giscus 配置后,评论功能才可用。