O que é frontmatter
Frontmatter é o bloco de metadados colocado no início de um arquivo Markdown. Ele fica entre linhas de três traços e usa uma estrutura de chave e valor.
A ferramenta lê esse bloco antes do corpo. O título e a data alimentam a página, e a descrição e as relações completam a listagem e os metadados de busca.
Campos comuns
Os campos variam com a coleção. Título, descrição, data e identificador aparecem na maior parte dos projetos. A imagem, as tags e os relacionados completam a página.
O nome do campo precisa corresponder ao schema. Um campo com outro nome é ignorado, e a página aparece sem a informação que deveria trazer.
Validação e publicação
O build confere o tipo e a obrigatoriedade de cada campo. Um valor fora do formato esperado interrompe a geração ou deixa a página incompleta.
A validação precisa rodar no fechamento da publicação. O erro no frontmatter é barato de corrigir no arquivo e caro quando chega à página publicada.
Exemplo
Como conferir
Confira os campos obrigatórios, o formato da data e o identificador único. Rode o build, leia a mensagem do schema e abra a página gerada para comparar com os metadados.
O Markdown estrutura o corpo, e o schema valida o cabeçalho. A documentação registra os campos de cada coleção.
Dúvidas frequentes
Perguntas frequentes sobre Frontmatter
- Frontmatter é a mesma coisa que o corpo do texto?
- Não. O frontmatter guarda os metadados que a ferramenta lê. O corpo guarda o texto que o leitor encontra na página.
- Todo Markdown precisa de frontmatter?
- Só quando a ferramenta usa os campos para montar a página, a listagem ou a busca. Um documento simples pode começar direto pelo título.
- O que acontece quando um campo está errado?
- O build pode falhar ou a página pode aparecer sem a informação. O schema informa o campo e o tipo esperado, e a correção acontece no arquivo.
- Posso usar o mesmo campo em coleções diferentes?
- Pode, desde que o schema de cada coleção aceite o campo. A padronização mantém a listagem estável, e a validação evita que um valor ausente quebre a página.
Para continuar
Recursos relacionados
Documentação
Jekyll: frontmatter
Apresenta o bloco e os campos usados pelo gerador.
Abrir recursoDocumentação
Hugo: frontmatter
Explica os formatos e os campos de metadados.
Abrir recursoAplicação na formação
Developer Workspace
No Developer Workspace, o frontmatter aparece na criação do arquivo e na conferência dos campos no fechamento da publicação.
Conhecer a formação
Fontes consultadas
Referências deste verbete
Este verbete ajudou você?
Obrigado pela resposta. Ela fica salva apenas neste navegador.