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

Markdown and 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はマークダウンのスーパーセットで、JSXをマークダウンファイル内で直接書くことができます。これは、動的なインタラクティビティを追加し、コンテンツ内にReactコンポーネントを埋め込むための強力な方法です。

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

Good to know: 完全な動作例を見たい方は、Portfolio Starter Kitテンプレートをご覧ください。

依存関係のインストール​

@next/mdxパッケージと関連パッケージは、Next.jsを設定してマークダウンとMDXを処理できるようにするために使用されます。ローカルファイルからデータを取得するために、/pagesまたは/appディレクトリに直接 .mdや.mdx拡張子を持つページを作成することができます。

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 = {
  // `pageExtensions`を設定してマークダウンとMDXファイルを含める
  pageExtensions: ['js', 'jsx', 'md', 'mdx', 'ts', 'tsx'],
  // 必要に応じて、下に他のNext.jsの設定を追加
}

const withMDX = createMDX({
  // 必要に応じて、マークダウンプラグインをここに追加
})

// 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のレンダリング​

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

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

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

App Routerアプリでは、メタデータを利用できることが含まれます。

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

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

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

import { MyComponent } from 'my-component'

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

This is some **bold** and _italics_ text.

This is a list in markdown:

- One
- Two
- Three

Checkout my React component:

<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を使用し、ReactコンポーネントをMDXページ内に直接インポートすることもできます:

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

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

This is some **bold** and _italics_ text.

This is a list in markdown:

- One
- Two
- Three

Checkout my React component:

<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}

This is a list in markdown:

- One
- Two
- Three

次のHTMLが生成されます:

<h2>This is a heading</h2>

<p>This is a list in 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'

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

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プラグインを使用する​

アプリケーションのスタイルにTailwindを使用している場合、@tailwindcss/typographyプラグインを使用すると、Tailwindの設定およびスタイルをマークダウンファイル内で再利用することができます。

このプラグインは、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}

メタデータは now、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プラグイン​

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

たとえば、GitHub Flavored Markdownをサポートするためにremark-gfmを使用することができます。

remarkとrehypeのエコシステムはESMのみなので、構成ファイルとしてnext.config.mjsまたはnext.config.tsを使用する必要があります。

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

/** @type {import('next').NextConfig} */
const nextConfig = {
  // ファイルに.mdx拡張子を許可
  pageExtensions: ['js', 'jsx', 'md', 'mdx', 'ts', 'tsx'],
  // 必要に応じて、下に他のNext.jsの設定を追加
}

const withMDX = createMDX({
  // 必要に応じて、マークダウンプラグインをここに追加
  options: {
    remarkPlugins: [remarkGfm],
    rehypePlugins: [],
  },
})

// MDXとNext.js設定を結合
export default withMDX(nextConfig)

Good to know:

現在、remarkとrehypeのプラグインは、JavaScript関数をRustに渡すことができないため、Turbopackでは使用できません。

リモート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が表示されます。

詳細: マークダウンをHTMLにどのように変換するのか？​

Reactはネイティブにマークダウンを理解しません。マークダウンのプレーンテキストは、まずHTMLに変換する必要があります。これはremarkとrehypeを使って達成できます。

remarkはマークダウンに関するツールのエコシステムです。rehypeも同様ですが、HTML用です。例えば、以下のコードスニペットはマークダウンを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) // マークダウン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コンパイラがサポートされています。このコンパイラはまだ実験的であり、本番環境での使用は推奨されません。新しいコンパイラを使用するには、next.config.jsを設定し、withMDXに渡す必要があります:

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構文を使用して解析・変換するかを設定
    },
  },
})