Frontmatter
Os campos que uma página pode ter além do título e da descrição, e os dois que a compilação preenche.
O Content só guarda o que o esquema de uma coleção declara, por isso esta é a lista completa: um campo não declarado é descartado em silêncio, antes de a barra lateral ou a pesquisa o verem.
O que escreves
| Campo | Tipo | O que faz |
|---|---|---|
title | string | Apresentado como o <h1> da página, e o seu título de SEO e social |
description | string | O resumo — barra lateral, cartões, imagem OG, llms.txt |
icon | string | Mostrado ao lado da entrada na barra lateral, na linha e nos cartões |
navigation | boolean | false esconde a página da navegação |
layout | string | landing apresenta a página sem o layout de documentação |
redirectFrom | string[] | URL antigos desta página — ver Mover uma página |
date | string | A data desta página, para o feed |
title e description são os dois cuja falta a compilação avisa. Nenhum parte
uma página, e ambos degradam em silêncio o índice, o cartão social e o
llms.txt.
title é apresentado como o cabeçalho. Um cabeçalho # no início do ficheiro é
o segundo <h1> da página.
O que a compilação preenche
| Campo | Preenchido por | Contém |
|---|---|---|
lastUpdated | o módulo git-meta | O último commit que tocou no ficheiro |
contributors | o módulo git-meta | Nome, número de commits e utilizador, por autor |
rawbody | o esquema da coleção | O Markdown tal como foi escrito |
sitemap | a integração do sitemap | Aquilo que põe a página no /sitemap.xml |
Escrever qualquer um deles à mão não serve de nada: a compilação sobrescreve-os.
Ambos os campos de git precisam de um histórico real, por isso uma fonte remota
precisa de history: true — ver a
referência de fontes.
O nome do ficheiro transporta mais duas coisas
- Um prefixo numérico ordena a árvore e é retirado do URL:
3.guides/2.deploy.mdé servido em/guides/deploy. Reordenar nunca move um URL. .draft.mdé um rascunho. É servido no servidor de desenvolvimento e não existe na compilação. Não hádraft: true, porque o conteúdo de uma coleção é declarado antes de qualquer ficheiro ter sido lido — ver Coleções.