Docs | Docusaurus

• Docs | Docusaurus

---

✅ Campos mais comuns (Docs plugin)

Segundo a documentação do plugin de docs: ([docusaurus.io][1])

Campo	Tipo	Padrão	Descrição
id	string	Caminho do arquivo (relativo)	Identificador único do documento. ([docusaurus.io][2])
title	string	Título extraído de # Título ou id	Texto que será usado como título da página, fallback para outros lugares. ([docusaurus.io][3])
sidebar_label	string	title	Texto mostrado na sidebar para esse documento. ([docusaurus.io][3])
sidebar_position	number	—	Controla a ordem do documento na sidebar (quando sidebar é automática). ([docusaurus.io][3])
sidebar_class_name	string	—	Adiciona uma classe CSS especial à entrada da sidebar para esse doc. ([docusaurus.io][3])
sidebar_custom_props	object	—	Permite definir props personalizados para o item da sidebar. ([docusaurus.io][3])
displayed_sidebar	string	—	Força que uma sidebar específica seja exibida nesta página (útil se você tiver múltiplas sidebars). ([docusaurus.io][3])
hide_title	boolean	false	Se true, oculta o título no topo da página (quando o título vem do front matter). ([docusaurus.io][3])
hide_table_of_contents	boolean	false	Se true, oculta o índice de conteúdo (TOC) que normalmente aparece ao lado. ([docusaurus.io][3])
toc_min_heading_level	number	2	Define o nível mínimo de heading que aparece no TOC (ex: h2). ([docusaurus.io][4])
toc_max_heading_level	number	—	Define o nível máximo de heading que aparece no TOC (ex: h3/h4). ([docusaurus.io][4])
slug	string	—	Permite personalizar a URL (rota) desse documento. ([docusaurus.io][5])
tags	array of strings	—	Lista de tags para categorizar o documento (útil para buscas, filtros). ([docusaurus.io][2])
description	string	Primeira linha de conteúdo	Descrição do documento, usada para SEO/meta tags. ([docusaurus.io][6])

---

⚠️ Outros campos em outros contextos

• Em páginas normais (@docusaurus/plugin-content-pages), há campos como draft, unlisted, keywords, image, etc. ([docusaurus.io][7])
• Você também pode definir arbitrary front matter—campos adicionais que seu site pode interpretar customizadamente ou usar em plugins. ([docusaurus.io][8])

---

🧠 Exemplos de uso

---
id: generics-ts
title: “Generics no TypeScript”
sidebar_position: 26
tags:
  - Generics
description: “Documentação sobre como usar generics no TypeScript com Docusaurus.”
slug: /docs/typescript-generics
hide_table_of_contents: false
toc_max_heading_level: 4
---

Nesse caso:

• sidebar_position: 26 coloca esse doc na posição 26 da sidebar (quando gerar automaticamente).
• tags adiciona a tag “Generics”.
• slug personaliza a URL.
• description melhora SEO/metadados.

---