Next.jsでMarkdownとMDXを使用する方法

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

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

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

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)

const withMDX = createMDX({
  extension: /\.(md|mdx)$/,
})

import type { MDXComponents } from 'mdx/types'
 
const components: MDXComponents = {}
 
export function useMDXComponents(): MDXComponents {
  return components
}

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

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

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

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

import Welcome from '@/markdown/welcome.mdx'
 
export default function Page() {
  return <Welcome />
}

export default async function Page({
  params,
}: {
  params: Promise<{ slug: string }>
}) {
  const { slug } = await params
  const { default: Post } = await import(`@/content/${slug}.mdx`)
 
  return <Post />
}
 
export function generateStaticParams() {
  return [{ slug: 'welcome' }, { slug: 'about' }]
}
 
export const dynamicParams = false

## This is a heading
 
This is a list in markdown:
 
- One
- Two
- Three

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

import type { MDXComponents } from 'mdx/types'
import Image, { ImageProps } from 'next/image'
 
// このファイルにより、カスタムReactコンポーネントを提供して、
// MDXファイルで使用できます。インラインスタイル、他のライブラリの
// コンポーネント、その他を含む、任意のReactコンポーネントを
// インポートして使用できます。
 
const components = {
  // 組み込みコンポーネントをカスタマイズできます。例えば、スタイルを追加するには。
  h1: ({ children }) => (
    <h1 style={{ color: 'red', fontSize: '48px' }}>{children}</h1>
  ),
  img: (props) => (
    <Image
      sizes="100vw"
      style={{ width: '100%', height: 'auto' }}
      {...(props as ImageProps)}
    />
  ),
} satisfies MDXComponents
 
export function useMDXComponents(): MDXComponents {
  return components
}

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

export default function MdxLayout({ children }: { children: React.ReactNode }) {
  // ここで共有レイアウトまたはスタイルを作成します
  return <div style={{ color: 'blue' }}>{children}</div>
}

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

export const metadata = {
  author: 'John Doe',
}
 
# Blog post

import BlogPost, { metadata } from '@/content/blog-post.mdx'
 
export default function Page() {
  console.log('metadata: ', metadata)
  //=> { author: 'John Doe' }
  return <BlogPost />
}

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({
  // Markdownプラグインをここに追加してください（希望に応じて）
  options: {
    remarkPlugins: [remarkGfm],
    rehypePlugins: [],
  },
})
 
// MDXとNext.js設定を統合
export default withMDX(nextConfig)

import createMDX from '@next/mdx'
 
/** @type {import('next').NextConfig} */
const nextConfig = {
  pageExtensions: ['js', 'jsx', 'md', 'mdx', 'ts', 'tsx'],
}
 
const withMDX = createMDX({
  options: {
    remarkPlugins: [
      // オプションなし
      'remark-gfm',
      // オプション付き
      ['remark-toc', { heading: 'The Table' }],
    ],
    rehypePlugins: [
      // オプションなし
      'rehype-slug',
      // オプション付き
      ['rehype-katex', { strict: true, throwOnError: true }],
    ],
  },
})
 
export default withMDX(nextConfig)

import { MDXRemote } from 'next-mdx-remote-client/rsc'
 
export default async function RemoteMdxPage() {
  // MDXテキスト - データベース、CMS、fetch、どこからでも取得できます...
  const res = await fetch('https://...')
  const markdown = await res.text()
  return <MDXRemote source={markdown} />
}

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をMarkdown ASTに変換
    .use(remarkRehype) // HTMLASTに変換
    .use(rehypeSanitize) // HTMLインプットをサニタイズ
    .use(rehypeStringify) // ASTをシリアライズされたHTMLに変換
    .process('Hello, Next.js!')
 
  console.log(String(file)) // <p>Hello, Next.js!</p>
}

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

module.exports = withMDX({
  experimental: {
    mdxRs: {
      jsxRuntime?: string            // カスタムjsxランタイム
      jsxImportSource?: string       // カスタムjsxインポートソース、
      mdxType?: 'gfm' | 'commonmark' // mdxファイルを解析・変換するために使用するMDX構文の種類を設定
    },
  },
})