跳到主要内容

MDX 常用标注

本文档包含 Docusaurus 中 MDX 支持的所有核心格式案例,

1 提示(tip)

这里是提示内容,用于补充技巧、最佳实践,支持 加粗、斜体、链接。

  • 支持无序列表
  • 支持嵌套代码片段:console.log("hello")

代码示例:

:::tip[小提示]
这里是提示内容,用于补充技巧、最佳实践,支持 **加粗**、*斜体*、[链接](/docs)。
- 支持无序列表
- 支持嵌套代码片段:`console.log("hello")`
:::

效果展示:

小提示

这里是提示内容,用于补充技巧、最佳实践,支持 加粗斜体链接

  • 支持无序列表
  • 支持嵌套代码片段:console.log("hello")

2 备注(note)

代码示例:

:::note[备注]
用于补充不重要但需说明的信息,不影响主流程阅读,适合添加额外说明。
:::

效果展示:

备注

用于补充不重要但需说明的信息,不影响主流程阅读,适合添加额外说明。

3 疑问/信息(info)

代码示例:

:::info[常见疑问]
Q: MDX 与普通 Markdown 的区别是什么?
A: MDX 支持在 Markdown 中直接嵌入 React 组件和交互逻辑,普通 Markdown 不支持。
:::

效果展示:

常见疑问

Q: MDX 与普通 Markdown 的区别是什么? A: MDX 支持在 Markdown 中直接嵌入 React 组件和交互逻辑,普通 Markdown 不支持。

4 警告(caution)

代码示例:

:::caution[注意事项]
操作前请**备份数据**,避免配置错误导致项目异常,建议测试环境验证后再部署。
:::

效果展示:

注意事项

操作前请备份数据,避免配置错误导致项目异常,建议测试环境验证后再部署。

5 重点/危险(danger)

代码示例:

:::danger[重点强调]
此 API 已**废弃**,请立即改用 v2 版本:`/api/v2/user`,旧版本将在下次迭代中移除。
:::

效果展示:

重点强调

此 API 已废弃,请立即改用 v2 版本:/api/v2/user,旧版本将在下次迭代中移除。