先写出可以独立阅读的内容
组件适合承载需要额外结构或交互的材料。可以用提示框标出操作条件,也可以用代码组呈现多种工具的等价命令。主流程的上下文和完成条件应写在普通正文中,方便搜索和跨平台阅读。
本指南使用 Nuxt Content 的 MDC 块语法嵌入组件。不同文档站可用的组件、属性和样式各有约定。复制示例前先看项目已有写法,并在目标版本预览。
使用提示块
::note
配置变更会在**下一次构建**时生效。
::
它在本指南中会渲染为以下内容。
配置变更会在下一次构建时生效。
编写代码组选项
用代码组语法组织可互换的命令。标签写清平台、语言或包管理器。每个选项应从相同起点达到相同结果,并能独立复制。前后连续执行的步骤可以按有序列表编排。
::code-group
```bash [macOS 与 Linux]
node --version
```
```powershell [Windows]
node --version
```
::
核对交互和锚点
切换每个选项并试用复制按钮。用键盘进入组件并切换,确认焦点可见。组件里有标题、小节和链接时,检查其目录层级、锚点和搜索结果。将正文链接指向常显的标题,读者就能直接定位相关信息。