Skip to content

非公式本サイトは非公式の日本語ドキュメントであり、Cloudflare 公式サイトではありません。最新情報はdevelopers.cloudflare.comをご確認ください。

Markdown と MDX

最終更新 Markdown で表示Agent セットアップ

Cloudflare のドキュメントページは MDX で書きます。MDX は JSX コンポーネントで拡張した Markdown です。各ページは .mdx ファイルで、先頭に frontmatter ブロックがあり、その後に本文が続きます。

本文

本文は標準の 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.
```

役に立ちましたか?