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.
Os controlos da página
Mais oito campos, cada um a desligar uma peça daquilo que o duxt desenha à volta de uma página. É assim que uma página diz para que serve: uma referência de API que quer toda a largura, uma página legal sem «Esta página foi útil?», um esboço que não deve aparecer na pesquisa.
| Campo | Tipo | Por omissão | O que controla |
|---|---|---|---|
toc | false | { maxDepth } | ligado, até h3 | O índice, e até que profundidade vai |
breadcrumb | boolean | duxt.breadcrumb | O trilho por cima do título |
prevNext | boolean | true | O par anterior/seguinte por baixo do artigo |
feedback | boolean | true | A linha «Esta página foi útil?» |
pageInfo | boolean | true | Ligação de edição, última atualização, contribuidores |
copyPage | boolean | true | Copiar página, e o menu de entrega a um modelo |
fullWidth | boolean | false | true retira o limite de largura de leitura |
search | boolean | true | false retira a página da pesquisa |
---
title: Termos de serviço
feedback: false
prevNext: false
search: false
---
Eles combinam-se, e nenhum deles implica outro. fullWidth: true retira a
medida de leitura e mais nada — a coluna do índice e o bloco de proveniência
ficam, a não ser que também sejam desligados — e copyPage: false deixa o bloco
de proveniência em paz. Uma página que não define nenhum deles fica exatamente
como sempre esteve.
breadcrumb é o único com um interruptor de todo o site por trás,
duxt.breadcrumb. A página ganha onde quer que se pronuncie, por isso um site
que escondeu o trilho em todo o lado pode repô-lo na única página cujo trilho é
precisamente o ponto.
Até que profundidade vai o índice
toc: false deixa cair a coluna. A forma de objeto define o cabeçalho mais
profundo que lista, escrito como nível de cabeçalho — a lista começa sempre em
h2, e h3 é o valor por omissão.
---
title: Configuração
toc:
maxDepth: 4
---
maxDepth aceita de 2 a 6. Qualquer outra coisa recai no valor por omissão
em vez de esvaziar a coluna: não existe h7, e h1 é o título.
O que search: false faz, e o que não faz
Retira a página de todas as superfícies que o duxt oferece para encontrar
alguma coisa: a caixa de pesquisa, o seu recurso às aproximações, a ferramenta
MCP search_docs, e tanto llms.txt como llms-full.txt.
Não muda nada no endereço da página. O URL, o canónico, a entrada do sitemap
e os metadados de robots ficam intactos, a página é apresentada como sempre foi,
e o read_page do MCP continua a responder por ela. A página fica inencontrável,
não despublicada. Para manter uma página fora da árvore de navegação, isso é
navigation: false; para a manter fora de um motor de pesquisa, isso é assunto
do rastreador e não deste campo.
Não há campo para isso, deliberadamente. fullWidth mantém o cabeçalho e a
navegação da esquerda, porque uma página que retirasse a saída é uma página onde
o leitor fica preso. layout: landing continua a ser a única fuga explícita a
toda a casca da documentação.
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.