コンテンツへスキップ
アプリケーションの構築設定MDX

マークダウンとMDX

マークダウンは、テキストのフォーマットに使用される軽量のマークアップ言語です。プレーンテキストの構文を使用して記述し、構造的に有効なHTMLに変換できます。ウェブサイトやブログへのコンテンツ作成によく使用されます。

記述する…

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

出力

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

MDXは、マークダウンのスーパーセットであり、JSXをマークダウンファイルに直接記述できます。これは、コンテンツ内に動的なインタラクションを追加し、Reactコンポーネントを埋め込むための強力な方法です。

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

重要な点：ポートフォリオスターターキットテンプレートを参照して、完全な動作例を確認してください。

依存関係のインストール

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

Next.jsでMDXをレンダリングするには、これらのパッケージをインストールします。

ターミナル
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 = {
  // Configure `pageExtensions` to include markdown and MDX files
  pageExtensions: ['js', 'jsx', 'md', 'mdx', 'ts', 'tsx'],
  // Optionally, add any other Next.js config below
}
 
const withMDX = createMDX({
  // Add markdown plugins here, as desired
})
 
// Merge MDX config with Next.js config
export default withMDX(nextConfig)

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

mdx-components.tsxファイルの追加

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

mdx-components.tsx
import type { MDXComponents } from 'mdx/types'
 
export function useMDXComponents(components: MDXComponents): MDXComponents {
  return {
    ...components,
  }
}

重要な点:

  • App Routerで@next/mdxを使用するには、mdx-components.tsxが**必須**であり、これがないと動作しません。
  • mdx-components.tsxファイル規約の詳細については、こちらをご覧ください。
  • カスタムスタイルとコンポーネントの使用方法については、こちらをご覧ください。

MDXのレンダリング

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

ファイルベースルーティングの使用

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

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

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

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

import { MyComponent } from 'my-component'
 
# 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ページが表示されます。

インポートの使用

/pagesディレクトリ内に新しいページを作成し、MDXファイルを任意の場所に作成します。

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

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

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

pages/mdx-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 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'
 
// This file allows you to provide custom React components
// to be used in MDX files. You can import and use any
// React component you want, including inline styles,
// components from other libraries, and more.
 
export function useMDXComponents(components: MDXComponents): MDXComponents {
  return {
    // Allows customizing built-in components, e.g. to add styling.
    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コンポーネントにローカルスタイルとコンポーネントを渡すことで、特定のページに適用できます。これらはグローバルスタイルとコンポーネントとマージされ、上書きされます。

pages/mdx-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ページでレイアウトを共有するには、レイアウトコンポーネントを作成します。

components/mdx-layout.tsx
export default function MdxLayout({ children }: { children: React.ReactNode }) {
  // Create any shared layout or styles here
  return <div style={{ color: 'blue' }}>{children}</div>
}

次に、レイアウトコンポーネントをMDXページにインポートし、MDXコンテンツをレイアウトでラップしてエクスポートします。

import MdxLayout from '../components/mdx-layout'
 
# Welcome to my MDX page!
 
export default function MDXPage({ children }) {
  return <MdxLayout>{children}</MdxLayout>
 
}

Tailwind typographyプラグインの使用

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

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

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

MDXページでレイアウトを共有するには、レイアウトコンポーネントを作成します。

components/mdx-layout.tsx
export default function MdxLayout({ children }: { children: React.ReactNode }) {
  // Create any shared layout or styles here
  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>
  )
}

次に、レイアウトコンポーネントをMDXページにインポートし、MDXコンテンツをレイアウトでラップしてエクスポートします。

import MdxLayout from '../components/mdx-layout'
 
# Welcome to my MDX page!
 
export default function MDXPage({ children }) {
  return <MdxLayout>{children}</MdxLayout>
 
}

フロントマター

フロントマターは、ページに関するデータを保存するために使用できるYAMLのようなキー/値ペアです。@next/mdxはデフォルトではフロントマターをサポートしていませんが、remark-frontmatterなど、MDXコンテンツにフロントマターを追加するための多くのソリューションがあります。

@next/mdxは、他のJavaScriptコンポーネントと同様にエクスポートを使用できます。

メタデータは、MDXファイルの外で参照できるようになりました。

pages/blog.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などのパッケージを使用して、投稿のディレクトリを読み取り、メタデータを取り出すことができます。

重要な点:

RemarkとRehypeプラグイン

必要に応じて、remarkとrehypeプラグインを提供してMDXコンテンツを変換できます。

例えば、remark-gfmを使用してGitHub Flavored 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 = {
  // Configure `pageExtensions`` to include MDX files
  pageExtensions: ['js', 'jsx', 'md', 'mdx', 'ts', 'tsx'],
  // Optionally, add any other Next.js config below
}
 
const withMDX = createMDX({
  // Add markdown plugins here, as desired
  options: {
    remarkPlugins: [remarkGfm],
    rehypePlugins: [],
  },
})
 
// Wrap MDX and Next.js config with each other
export default withMDX(nextConfig)

リモートMDX

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

重要な注意点: 注意して進めてください。MDXはJavaScriptにコンパイルされ、サーバーで実行されます。信頼できるソースからのMDXコンテンツのみをフェッチしてください。そうでない場合、リモートコード実行（RCE）につながる可能性があります。

次の例ではnext-mdx-remoteを使用しています。

pages/mdx-page-remote.tsx
import { serialize } from 'next-mdx-remote/serialize'
import { MDXRemote, MDXRemoteSerializeResult } from 'next-mdx-remote'
 
interface Props {
  mdxSource: MDXRemoteSerializeResult
}
 
export default function RemoteMdxPage({ mdxSource }: Props) {
  return <MDXRemote {...mdxSource} />
}
 
export async function getStaticProps() {
  // MDX text - can be from a local file, database, CMS, fetch, anywhere...
  const res = await fetch('https:...')
  const mdxText = await res.text()
  const mdxSource = await serialize(mdxText)
  return { props: { mdxSource } }
}

/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) // Convert into markdown AST
    .use(remarkRehype) // Transform to HTML AST
    .use(rehypeSanitize) // Sanitize HTML input
    .use(rehypeStringify) // Convert AST into serialized 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            // Custom jsx runtime
      jsxImportSource?: string       // Custom jsx import source,
      mdxType?: 'gfm' | 'commonmark' // Configure what kind of mdx syntax will be used to parse & transform
    },
  },
})

重要な点:

このオプションは、Turbopack（`next dev --turbo`）を使用している場合に、MarkdownとMDXを処理する際に必要です。