Cabeçalho de metadados
Aprenda a usar o cabeçalho de metadados em arquivos MDX.
O cabeçalho de metadados é uma parte importante de um arquivo MDX. Ele é usado para definir informações sobre o conteúdo do arquivo, como título, descrição, autor, data de publicação, etc.
O cabeçalho de metadados é definido no início do arquivo, entre --- (três hífens) no início e no final.
Estrutura
O cabeçalho de metadados é definido em formato de chave-valor, onde a chave é o nome do metadado e o valor é o conteúdo do metadado.
Exemplo:
---
title: Título do documento
description: Descrição do documento
---Dependendo do tipo de documento (documentação, post de blog, etc.), diferentes metadados podem ser usados.
Metadados para documentação
titledescriptionlinkssourcedocsblogapi
Exemplo:
---
title: Título do documento
description: Descrição do documento
links:
source: https://google.com
docs: /docs
blog: /blog
api: https://google.com
---Metadados para post de blog
author_id
É o identificador do autor do post.
Ele deve corresponder ao id do autor definido no arquivo src/config/blog.ts,
que é o arquivo que contém os dados completos dos autores.
og_image
É a imagem que será usada como imagem de destaque do post ao ser compartilhada nas redes sociais caso não queira usar a imagem gerada automaticamente.
As imagens devem ser armazenadas na pasta public/blog-og.
Use somente o nome e a extensão do arquivo da imagem.
titleexcerptdateauthor_idog_imagetagslinkssourcedocsblogapi
Exemplo:
---
title: Título do post
date: 2024-08-07 22:33:00
excerpt: Resumo do post
author_id: daltonmenezes
og_image: introducing-blogs-og.jpg
links:
source: https://google.com
docs: /docs
blog: /blog
api: https://google.com
tags: [next.js, open-graph, blog]
---