Documentação

Documentação

Este texto foi traduzido automaticamente com IA a partir do original em English. Pode ter erros.

Ver o original (English)

Páginas organizadas em grupos, com menu lateral, sumário e navegação.

As docs são a seção que você está lendo. Elas ficam em uma pasta raiz cuja nota _index tem blup: docs.

Como ela é organizada

  • Cada nota é uma página.
  • Cada subpasta é um grupo no menu lateral, com o título do seu _index.
  • O _index da pasta de docs é a página inicial.
  • A ordem segue a propriedade weight (do menor para o maior) e, sem ela, o nome da nota.
Docs/
├── _index.md           blup: docs
├── Getting started/
│   ├── _index.md       title: Getting started, weight: 1
│   ├── Installation.md   weight: 1
│   └── Create your first site.md   weight: 2
└── Writing/
    └── _index.md       weight: 2

O que cada página recebe

  • Um menu lateral com todos os grupos; o grupo atual permanece aberto.
  • Nesta página: os títulos ## e ###, ao lado do texto.
  • Um breadcrumb (Home > Docs > grupo) no topo.
  • Anterior e Próximo no final, seguindo a ordem do menu.
  • Pesquisa em todas as páginas do site.

Criar uma página

  • No Blup Studio: clique em uma subpasta de Docs e depois em New note (ou Ctrl+N). Preencha Title, Description e Order nas propriedades.
  • Manualmente: crie a nota na subpasta e escreva title, description e weight no topo.

Para um novo grupo, crie uma subpasta com uma nota _index (title, description e weight).

Uma descrição curta ajuda

A propriedade description aparece abaixo do título e no Google. Uma frase é suficiente.