如何使用 Next.js 和 MDX 建立博客

前言

将使用的套件：

next Next.js 框架
next-mdx-remote 处理和载入 MDX 内容
gray-matter 解析 Markdown 的前置资料

本教学的源代码库：

https://github.com/tszhong0411/nextjs-mdx-blog

示例

线上示例

如何建立博客

首先，我们使用以下指令建立 Next.js 项目：

Terminal

yarn create next-app nextjs-mdx-blog

接着，建立以下档案：

components/layout.jsx - 将所有组件包装在容器中（可选，用于样式）
data/blog/*.mdx - 博客文章
lib/format-date.js - 将日期格式化为 MM DD, YYYY
pages/blog/[slug].jsx - 文章页面，使用动态路由

components

layout.jsx

data

blog

markdown.mdx

nextjs.mdx

react.mdx

lib

format-date.js

mdx.js

pages

blog

[slug].jsx

如何处理 Markdown 档案

首先建立变数 const root，其值为根目录，process.cwd() 方法返回当前 Node.js 进程的工作目录。

lib/mdx.js

const root = process.cwd()

接着定义变数 POSTS_PATH，用于储存文章档案的路径。

lib/mdx.js

import path from 'path'

const POSTS_PATH = path.join(root, 'data', 'blog') 
// 输出: A:/nextjs-mdx-blog/data/blog

使用 fs 读取该目录下的内容，即 data/blog 下的所有档案名。

lib/mdx.js

import fs from 'fs'

export const allSlugs = fs.readdirSync(POSTS_PATH)
// 输出: ['markdown.mdx', 'nextjs.mdx', 'react.mdx']

然后撰写一个函数移除档案后缀名，稍后会用到。

lib/mdx.js

export const formatSlug = (slug) => slug.replace(/\.mdx$/, '')
/**
 * 示例: formatSlug('markdown.mdx')
 * 输出: 'markdown'
 */

接着根据 slug 获取文章内容。

lib/mdx.js

export const getPostBySlug = async (slug) => {
  const postFilePath = path.join(POSTS_PATH, `${slug}.mdx`)
  // 输出: A:/nextjs-mdx-blog/data/blog/slug.mdx
  const source = fs.readFileSync(postFilePath)
  // 返回档案内容

  const { content, data } = matter(source)
  /*
   * 示例:
   *  ---
   *  title: Hello
   *  slug: home
   *  ---
   *  <h1>Hello world!</h1>
   *
   * 返回:
   *  {
   *    content: '<h1>Hello world!</h1>',
   *    data: {
   *      title: 'Hello',
   *      slug: 'home'
   *    }
   *  }
   */

  const mdxSource = await serialize(content)
  // 使用 serialize (next-mdx-remote) 处理内容

  const frontMatter = {
    ...data,
    slug
  }
  // 将 slug 加入前置资料，稍后会用到

  return {
    source: mdxSource,
    frontMatter
  }
}

接下来可以获取所有文章，以显示在首页。

lib/mdx.js

export const getAllPosts = () => {
  const frontMatter = []

  allSlugs.forEach((slug) => {
    const source = fs.readFileSync(path.join(POSTS_PATH, slug), 'utf-8')

    const { data } = matter(source)

    frontMatter.push({
      ...data,
      slug: formatSlug(slug),
      date: new Date(data.date).toISOString()
    })
  })

  return frontMatter.sort((a, b) => dateSortDesc(a.date, b.date))
}

// 按日期降序排序
const dateSortDesc = (a, b) => {
  if (a > b) return -1
  if (a < b) return 1

  return 0
}

格式化日期

lib/format-date.js

export const formatDate = (date) =>
  new Date(date).toLocaleDateString('en', {
    year: 'numeric',
    month: 'long',
    day: 'numeric'
  })
/*
 * formatDate('2022-08-21T00:00:00Z')
 * 输出: 'August 21, 2022'
 */

首页

pages/index.jsx

import { formatDate } from '../lib/format-date'
import { getAllPosts } from '../lib/mdx'

import Link from 'next/link'

export default function Home({ posts }) {
  return (
    <>
      <h1 className='mb-8 text-6xl font-bold'>博客</h1>
      <hr className='my-8' />
      <ul className='flex flex-col gap-3'>
        {posts.map(({ slug, title, summary, date }) => (
          <li key={slug}>
            <Link href={`/blog/${slug}`}>
              <a className='block rounded-lg border border-solid border-gray-300 p-6 shadow-md'>
                <div className='flex justify-between'>
                  <h2>{title}</h2>
                  <time dateTime={date}>{formatDate(date)}</time>
                </div>
                <p className='mt-4'>{summary}</p>
              </a>
            </Link>
          </li>
        ))}
      </ul>
    </>
  )
}

// 使用 getStaticProps 获取所有文章
export const getStaticProps = async () => {
  const posts = getAllPosts()

  return {
    props: {
      posts
    }
  }
}

文章页面

pages/[slug].jsx

import { formatDate } from '../../lib/format-date'
import { allSlugs, formatSlug, getPostBySlug } from '../../lib/mdx'

import { MDXRemote } from 'next-mdx-remote'

export default function Blog({ post }) {
  const { title, date } = post.frontMatter

  return (
    <div>
      <h1 className='mb-2 text-6xl font-bold'>{title}</h1>
      <time dateTime={date} className='text-lg font-medium'>
        {formatDate(date)}
      </time>
      <hr className='my-8' />
      <article className='prose max-w-none'>
        <MDXRemote {...post.source} />
      </article>
    </div>
  )
}

export const getStaticProps = async ({ params }) => {
  const post = await getPostBySlug(params.slug)

  return {
    props: {
      post
    }
  }
}

export const getStaticPaths = async () => {
  const paths = allSlugs.map((slug) => ({
    params: {
      slug: formatSlug(slug)
    }
  }))
  /*
   * paths 输出:
   *   [
   *     { params: { slug: 'markdown' } },
   *     { params: { slug: 'nextjs' } },
   *     { params: { slug: 'react' } }
   *   ]
   */

  return {
    paths,
    fallback: false
  }
}

这样，一个简单的博客就完成了。