基础语法 / 代码
代码
代码语法最常见的用途不是炫技,而是把命令、文件路径、配置键名和日志片段写得足够明确,方便别人照着操作。
行内代码
短命令、文件名和配置项适合放进行内代码,让读者一眼识别“这是一段需要照抄的东西”。
在发布前先运行 `npm run build`,产物会输出到 `dist/` 目录。 缩进代码块
基础 Markdown 里,给每一行前面缩进四个空格,就可以插入一整段代码或命令输出:
npm install
npm run dev
npm run build 如果你希望指定语言并获得更清楚的高亮,可以继续看 围栏代码块 。
效果预览
发布文档里常见的写法:先执行
npm run build
,再把生成结果部署到
dist/
。
npm install npm run dev npm run build
显示反引号
如果你的示例本身就包含反引号,可以使用双反引号把整段包起来:
``用 `astro build` 描述命令本身`` 写作建议
- 命令、路径和配置键名尽量用代码样式,不要让读者猜哪些词需要照抄。
- 只放最小可执行片段,能三行说清楚的不要塞成几十行。
- 如果代码块只是为了展示输出结果,考虑补一行上下文,说明“在哪执行”“执行后会得到什么”。
- 发布文档里的示例最好真跑过,避免把失效命令写进教程。
评论
评论区暂未开放。
需要先为这个仓库启用 GitHub Discussions,并完成 giscus 配置后,评论功能才可用。