Ir para o conteúdo principal

Como construir um blog com Next.js e MDX

Escrito por
Yuri Cunha
Yuri Cunha
Publicado em
22 de ago. de 2022
Visualizações
--
Comentários
--
Como construir um blog com Next.js e MDX

Prefácio

Os pacotes a serem utilizados:

O repositório para este tutorial:

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

Demonstração

Demonstração online

Como criar um blog

Primeiro, criamos o projeto Next.js com o seguinte comando:

Terminal
yarn create next-app nextjs-mdx-blog

Em seguida, crie os seguintes arquivos:

  • components/layout.jsx - Envolve todos os componentes em um container (opcional, serve apenas para o estilo)
  • data/blog/*.mdx - Artigos do blog
  • lib/format-date.js - Formata a data como MM DD, YYYY
  • pages/blog/[slug].jsx - Página do artigo, utilizando rotas dinâmicas
components
layout.jsx
data
blog
markdown.mdx
nextjs.mdx
react.mdx
lib
format-date.js
mdx.js
pages
blog
[slug].jsx

Como manipular arquivos Markdown

Primeiro, definimos const root — o diretório raiz, e o método process.cwd() retorna o diretório de trabalho atual do processo Node.js.

JavaScript
lib/mdx.js
const root = process.cwd()

Outra variável, POSTS_PATH, define o caminho onde os arquivos dos artigos estão armazenados.

JavaScript
lib/mdx.js
import path from 'path'

const POSTS_PATH = path.join(root, 'data', 'blog') 
// Saída: A:/nextjs-mdx-blog/data/blog

Em seguida, usamos o fs para ler o conteúdo desse diretório, ou seja, todos os nomes de arquivos em data/blog.

JavaScript
lib/mdx.js
import fs from 'fs'

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

Depois, escreva uma função para remover a extensão do arquivo, que será utilizada posteriormente.

JavaScript
lib/mdx.js
export const formatSlug = (slug) => slug.replace(/\.mdx$/, '')
/**
 * Exemplo: formatSlug('markdown.mdx')
 * Retorno: 'markdown'
 */

O próximo passo é obter o conteúdo do artigo através do slug.

JavaScript
lib/mdx.js
export const getPostBySlug = async (slug) => {
  const postFilePath = path.join(POSTS_PATH, `${slug}.mdx`)
  // Saída: A:/nextjs-mdx-blog/data/blog/slug.mdx
  const source = fs.readFileSync(postFilePath)
  // Retorna o conteúdo do arquivo

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

  const mdxSource = await serialize(content)
  // Envia o conteúdo para serialize (next-mdx-remote) para tratamento

  const frontMatter = {
    ...data,
    slug
  }
  // Adiciona o slug no front matter, que será utilizado posteriormente

  return {
    source: mdxSource,
    frontMatter
  }
}

Então, você pode obter todos os artigos para serem exibidos na página inicial.

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

// Ordenado por data em ordem decrescente
const dateSortDesc = (a, b) => {
  if (a > b) return -1
  if (a < b) return 1

  return 0
}

Formatando a Data

JavaScript
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')
 * Retorno: 'August 21, 2022'
 */

Página Inicial

React
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'>Blog</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>
    </>
  )
}

// Use getStaticProps para obter todos os artigos
export const getStaticProps = async () => {
  const posts = getAllPosts()

  return {
    props: {
      posts
    }
  }
}

Página do Artigo

React
pages/blog/[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)
    }
  }))
  /*
   * Saída paths:
   *   [
   *     { params: { slug: 'markdown' } },
   *     { params: { slug: 'nextjs' } },
   *     { params: { slug: 'react' } }
   *   ]
   */

  return {
    paths,
    fallback: false
  }
}

Dessa forma, um blog simples está concluído.

Editar no GitHub
Última atualização: 24 de fev. de 2024