メインコンテンツまでスキップ

MarkdownとMDX

Markdownは、テキストをフォーマットするために使用される軽量マークアップ言語です。プレーンテキストの文法を使用して記述し、構造的に正しいHTMLに変換することができます。一般的に、ウェブサイトやブログでのコンテンツ作成に使用されます。

このように記述します...

I **love** using [Next.js](https://nextjs.org/)

出力：

<p>I <strong>love</strong> using <a href="https://nextjs.org/">Next.js</a></p>

MDXは、markdownのスーパーセットであり、markdownファイル内で直接JSXを書くことができます。コンテンツに動的なインタラクティビティを追加し、Reactコンポーネントを埋め込む強力な方法です。

Next.jsは、アプリケーション内のローカルMDXコンテンツと、サーバーで動的にフェッチされたリモートMDXファイルの両方をサポートできます。Next.jsのプラグインは、markdownとReactコンポーネントをHTMLに変換する処理を行い、Server Componentsでの使用もサポートしています（App Routerでデフォルト）です。

Good to know: 完全な動作例として、Portfolio Starter Kitテンプレートを参照してください。

依存関係をインストールする​

@next/mdxパッケージと関連パッケージを使用して、Next.jsがmarkdownとMDXを処理できるように構成します。ローカルファイルからデータを取得し、.mdまたは.mdx拡張子のページを/pagesまたは/appディレクトリ内に直接作成できます。

以下のパッケージをインストールして、Next.jsでMDXをレンダリングします：

Terminal
npm install @next/mdx @mdx-js/loader @mdx-js/react @types/mdx

next.config.mjsを設定する​

プロジェクトのルートにあるnext.config.mjsファイルを更新して、MDXを使用するように構成します：

next.config.mjs
import createMDX from '@next/mdx'

/** @type {import('next').NextConfig} */
const nextConfig = {
  // markdownおよびMDXファイルを含むように`pageExtensions`を構成します
  pageExtensions: ['js', 'jsx', 'md', 'mdx', 'ts', 'tsx'],
  // 必要に応じて、他のNext.jsの設定を下に追加します
}

const withMDX = createMDX({
  // 必要に応じてmarkdownプラグインをここに追加します
})

// MDX構成をNext.js構成と統合します
export default withMDX(nextConfig)

これにより、.mdおよび.mdxファイルをあなたのアプリケーションのページ、ルート、またはインポートとして機能させることができます。

mdx-components.tsxファイルを追加する​

プロジェクトのルートにmdx-components.tsx（または.js）ファイルを作成して、グローバルMDXコンポーネントを定義します。たとえば、pagesやappと同じレベル、または該当する場合はsrcの内部に配置します。

mdx-components.tsx
import type { MDXComponents } from 'mdx/types'

export function useMDXComponents(components: MDXComponents): MDXComponents {
  return {
    ...components,
  }
}

Good to know:

MDXをレンダリングする​

ファイルベースのルーティングを使用するか、他のページにMDXファイルをインポートすることで、MDXをレンダリングできます。

ファイルベースのルーティングを使用する場合​

ファイルベースのルーティングを使用する場合、他のページと同様にMDXページを使用できます。

App Routerアプリでは、メタデータを使用することもできます。

/appディレクトリ内に新しいMDXページを作成します：

  my-project
  ├── app
  │   └── mdx-page
  │       └── page.(mdx/md)
  |── mdx-components.(tsx/js)
  └── package.json

これらのファイルでMDXを使用でき、MDXページ内にReactコンポーネントを直接インポートすることもできます：

import { MyComponent } from 'my-component'

# Welcome to my MDX page! \{#welcome-to-my-mdx-page}

これはいくつかの**太字**と*イタリック*のテキストです。

これはmarkdownのリストです：

- One
- Two
- Three

私のReactコンポーネントをチェックしてください：

<MyComponent />

/mdx-pageルートに移動すると、レンダリングされたMDXページが表示されるはずです。

インポートを使用する場合​

/appディレクトリ内に新しいページを作成し、希望する場所にMDXファイルを作成します：

  my-project
  ├── app
  │   └── mdx-page
  │       └── page.(tsx/js)
  ├── markdown
  │   └── welcome.(mdx/md)
  |── mdx-components.(tsx/js)
  └── package.json

これらのファイルでMDXを使用でき、MDXページ内にReactコンポーネントを直接インポートすることもできます：

markdown/welcome.mdx
import { MyComponent } from 'my-component'

# Welcome to my MDX page! \{#welcome-to-my-mdx-page}

これはいくつかの**太字**と*イタリック*のテキストです。

これはmarkdownのリストです：

- One
- Two
- Three

私のReactコンポーネントをチェックしてください：

<MyComponent />

ページ内にMDXファイルをインポートして、コンテンツを表示します：

app/mdx-page/page.tsx
import Welcome from '@/markdown/welcome.mdx'

export default function Page() {
  return <Welcome />
}

/mdx-pageルートに移動すると、レンダリングされたMDXページが表示されるはずです。

カスタムスタイルとコンポーネントを使用する​

Markdownがレンダリングされると、ネイティブのHTML要素にマッピングされます。たとえば、次のmarkdownを書くと：

## This is a heading \{#this-is-a-heading}

これはmarkdownのリストです：

- One
- Two
- Three

次のHTMLが生成されます：

<h2>This is a heading</h2>

<p>これはmarkdownのリストです：</p>

<ul>
  <li>One</li>
  <li>Two</li>
  <li>Three</li>
</ul>

markdownをスタイル付けするには、生成されたHTML要素にマッピングするカスタムコンポーネントを提供することができます。スタイルとコンポーネントは、グローバル、ローカル、および共有レイアウトで実装できます。

グローバルスタイルとコンポーネント​

mdx-components.tsxにスタイルとコンポーネントを追加すると、アプリケーション内のすべての MDXファイルに影響します。

mdx-components.tsx
import type { MDXComponents } from 'mdx/types'
import Image, { ImageProps } from 'next/image'

// このファイルを使用して、MDXファイルで使用するカスタムReact
// コンポーネントを提供できます。インラインスタイルをはじめ、
// 他のライブラリからのコンポーネントなど、任意のReactコンポーネントを
// インポートして使用できます。

export function useMDXComponents(components: MDXComponents): MDXComponents {
  return {
    // ビルトインコンポーネントのカスタマイズを許可し、例：スタイリングを追加する。
    h1: ({ children }) => (
      <h1 style={{ color: 'red', fontSize: '48px' }}>{children}</h1>
    ),
    img: (props) => (
      <Image
        sizes="100vw"
        style={{ width: '100%', height: 'auto' }}
        {...(props as ImageProps)}
      />
    ),
    ...components,
  }
}

ローカルスタイルとコンポーネント​

インポートされたMDXコンポーネントに渡すことで、特定のページにローカルなスタイルとコンポーネントを適用できます。これらは、グローバルスタイルとコンポーネントと統合され、上書きされます。

app/mdx-page/page.tsx
import Welcome from '@/markdown/welcome.mdx'

function CustomH1({ children }) {
  return <h1 style={{ color: 'blue', fontSize: '100px' }}>{children}</h1>
}

const overrideComponents = {
  h1: CustomH1,
}

export default function Page() {
  return <Welcome components={overrideComponents} />
}

共有レイアウト​

MDXページ間でレイアウトを共有するには、App Routerのビルトインレイアウトサポートを使用できます。

app/mdx-page/layout.tsx
export default function MdxLayout({ children }: { children: React.ReactNode }) {
  // ここで共有レイアウトやスタイルを作成してください
  return <div style={{ color: 'blue' }}>{children}</div>
}

Tailwind typography pluginを使用する​

アプリケーションのスタイルにTailwindを使用している場合、@tailwindcss/typography pluginを使用すると、Tailwindの設定やスタイルをmarkdownファイルで再利用することができます。

このプラグインは、markdownなどのソースからのコンテンツブロックにタイポグラフィスタイルを追加するためのproseクラスを追加します。

Tailwind typographyのインストールを行い、共有レイアウトでproseを追加します。

app/mdx-page/layout.tsx
export default function MdxLayout({ children }: { children: React.ReactNode }) {
  // ここで共有レイアウトやスタイルを作成してください
  return (
    <div className="prose prose-headings:mt-8 prose-headings:font-semibold prose-headings:text-black prose-h1:text-5xl prose-h2:text-4xl prose-h3:text-3xl prose-h4:text-2xl prose-h5:text-xl prose-h6:text-lg dark:prose-headings:text-white">
      {children}
    </div>
  )
}

Frontmatter​

Frontmatterは、ページのデータを格納するために使用できるYAMLのようなキー/値のペアリングです。@next/mdxはデフォルトでfrontmatterをサポートしていませんが、次のような方法でMDXコンテンツにfrontmatterを追加できます：

@next/mdxは、他のJavaScriptコンポーネントのようにエクスポートを使用することを許可しています：

content/blog-post.mdx
export const metadata = {
  author: 'John Doe',
}

# Blog post \{#blog-post}

メタデータは、MDXファイルの外部で参照することができます：

app/blog/page.tsx
import BlogPost, { metadata } from '@/content/blog-post.mdx'

export default function Page() {
  console.log('metadata: ', metadata)
  //=> { author: 'John Doe' }
  return <BlogPost />
}

一般的なユースケースは、MDXのコレクションを反復し、データを抽出する場合です。たとえば、すべてのブログ投稿からブログインデックスページを作成する場合です。Nodeのfsモジュールやglobbyなどのパッケージを使用して、投稿のディレクトリを読み取り、メタデータを抽出することができます。

Good to know:

  • fs、globbyなどの使用はサーバーサイドでのみ可能です。
  • 完全な動作例として、Portfolio Starter Kitテンプレートを参照してください。

RemarkとRehypeプラグイン​

オプションで、MDXコンテンツを変換するためのremarkやrehypeプラグインを提供することができます。

たとえば、remark-gfmを使用して、GitHubスタイルのmarkdownをサポートすることができます。

remarkとrehypeのエコシステムはESMオンリーなので、設定ファイルとしてnext.config.mjsを使用する必要があります。

next.config.mjs
import remarkGfm from 'remark-gfm'
import createMDX from '@next/mdx'

/** @type {import('next').NextConfig} */
const nextConfig = {
  // MDXファイルを含むように`pageExtensions`を構成します
  pageExtensions: ['js', 'jsx', 'md', 'mdx', 'ts', 'tsx'],
  // 必要に応じて、他のNext.jsの設定を下に追加します
}

const withMDX = createMDX({
  // 必要に応じてmarkdownプラグインをここに追加します
  options: {
    remarkPlugins: [remarkGfm],
    rehypePlugins: [],
  },
})

// MDXとNext.jsの設定を互いにラップします
export default withMDX(nextConfig)

リモートMDX​

MDXファイルやコンテンツが別の場所にある場合、サーバーで動的にフェッチすることができます。これは、別のローカルフォルダーやCMS、データベースなど、他の場所に保存されたコンテンツに役立ちます。この用途に人気のあるコミュニティパッケージはnext-mdx-remoteです。

Good to know: 注意が必要です。MDXはJavaScriptにコンパイルされ、サーバーで実行されます。信頼できるソースからのみMDXコンテンツを取得する必要があります。さもないと、リモートコード実行（RCE）につながる可能性があります。

以下はnext-mdx-remoteを使用した例です：

app/mdx-page-remote/page.tsx
import { MDXRemote } from 'next-mdx-remote/rsc'

export default async function RemoteMdxPage() {
  // MDXテキスト - ローカルファイル、データベース、CMS、フェッチ、どこからでも取得できます...
  const res = await fetch('https://...')
  const markdown = await res.text()
  return <MDXRemote source={markdown} />
}

/mdx-page-remoteルートに移動すると、レンダリングされたMDXが表示されるはずです。

詳細解説：markdownをHTMLに変換するにはどうすればよいですか？​

Reactはネイティブにmarkdownを理解しません。まずmarkdownプレーンテキストをHTMLに変換する必要があります。これはremarkとrehypeで実現できます。

remarkはmarkdownに関するツールのエコシステムです。rehypeは同じですが、HTMLのためのものです。たとえば、次のコードスニペットは、markdownをHTMLに変換します：

import { unified } from 'unified'
import remarkParse from 'remark-parse'
import remarkRehype from 'remark-rehype'
import rehypeSanitize from 'rehype-sanitize'
import rehypeStringify from 'rehype-stringify'

main()

async function main() {
  const file = await unified()
    .use(remarkParse) // markdown ASTに変換します
    .use(remarkRehype) // HTML ASTに変換します
    .use(rehypeSanitize) // HTML入力をサニタイズします
    .use(rehypeStringify) // ASTをシリアライズされたHTMLに変換します
    .process('Hello, Next.js!')

  console.log(String(file)) // <p>Hello, Next.js!</p>
}

remarkとrehypeのエコシステムには、シンタックスハイライト、ヘッディングへのリンク、目次の生成などのプラグインがあります。

上記のように@next/mdxを使用する場合、remarkやrehypeを直接使用する必要がありません。これは処理済みです。ここでは@next/mdxパッケージが内部で行っていることを深く理解するために説明しています。

RustベースのMDXコンパイラーを使用する（実験的）​

Next.jsはRustで書かれた新しいMDXコンパイラーをサポートしています。このコンパイラーはまだ実験的であり、本番での使用は推奨されていません。新しいコンパイラーを使用するには、withMDXに渡すときにnext.config.jsを構成する必要があります：

next.config.js
module.exports = withMDX({
  experimental: {
    mdxRs: true,
  },
})

mdxRsは、mdxファイルを変換する方法を構成するためにオブジェクトも受け取ります。

next.config.js
module.exports = withMDX({
  experimental: {
    mdxRs: {
      jsxRuntime?: string            // カスタムjsxランタイム
      jsxImportSource?: string       // カスタムjsxインポートソース
      mdxType?: 'gfm' | 'commonmark' // 解析および変換に使用されるmdx構文のタイプを設定
    },
  },
})

Good to know:

markdownとMDXをTurbopack（next dev --turbopack）を使用して処理する場合、このオプションが必要です。