跳转到内容
本站为社区维护的非官方中文翻译,与 Cloudflare, Inc. 无关联。本站不提供账户登录,请勿在任何非官方站点输入您的 Cloudflare 账户信息。官方文档:developers.cloudflare.com

Markdown 与 MDX

最后更新 查看 MarkdownAgent 设置

Cloudflare 文档页面使用 MDX 撰写,即扩展了 JSX 组件的 Markdown。每个页面都是带有顶部 frontmatter 块的 .mdx 文件,其后是正文内容。

正文内容

正文使用标准 Markdown。用它来写标题、段落、列表、表格、链接和代码:

## A heading

A paragraph with a [link](/style-guide/) and `inline code`.

- A list item
- Another list item

撰写这些元素的规则,请参阅格式部分。

导入组件

组件可以提供纯 Markdown 无法实现的格式,例如标签页、旁注和可折叠区块。在 frontmatter 块之后从 ~/components 导入它们,然后即可在正文任意位置使用:

---
title: Example page
---

import { Aside } from "~/components";

<Aside type="note">This is an aside.</Aside>

各组件的 props 和要求,请参阅组件部分。

转义特殊字符

MDX 会将 {、}、< 和 > 视为语法。当这些字符属于正文内容而非代码时,请用反引号包裹,以便按字面量渲染:

Set the value to `{"key": "value"}`.

围栏代码块内的字符本身就是字面量,无需转义。

代码块

用小写语言标识符打开围栏代码块,以便正确高亮。没有对应语言的通用输出请使用 txt:

```js
const value = 1;
```

```txt
Deployment complete.
```

这篇文档对您有帮助吗?