Pular para o conteúdo principal

Entendendo o Diretório .docusaurus

O que é?​

O diretório 

.docusaurus
é uma pasta gerada automaticamente sempre que o site é executado localmente (
npm start
) ou construído para produção (
npm run build
). Ele armazena artefatos técnicos essenciais para o funcionamento do site — como rotas, registros de plugins, dados globais e configurações compiladas.

Importante

Não edite arquivos dentro do .docusaurus. Tudo será sobrescrito em cada build.

Quando e como ele é gerado?​

O 

.docusaurus
é regenerado automaticamente em três situações comuns:

AçãoO que acontece
npm start
Gera a pasta e mantém atualizada com hot reload
npm run build
Recria do zero, otimizada para produção
npm run clear
Remove .docusaurus; será recriada ao rodar novamente

Estrutura interna: o que tem lá dentro?​

Arquivos comuns​

ArquivoFunção
routes.js
Define rotas do site
registry.js
Lista todos os componentes React usados
globalData.json
Dados globais compartilhados entre plugins e temas
client-modules.js
Scripts do cliente usados pelo site
codeTranslations.json
Traduções reutilizáveis para internacionalização
site-metadata.json
Informações básicas sobre o site

Diretórios por plugin​

CaminhoDescrição
docusaurus-plugin-content-docs/
Conteúdo gerado da pasta 
docs/
docusaurus-plugin-content-pages/
Dados de páginas personalizadas
docusaurus-plugin-debug/
(dev only)		Ferramentas de debug

Fluxo de Geração (Visual)​

Comandos úteis​

npm start        # Gera e atualiza .docusaurus (modo dev)
npm run build    # Cria versão final do site
npm run clear    # Limpa o diretório .docusaurus
npm run serve    # Executa o site localmente após o build

Boas práticas​

Ignore no Git​

O diretório 

.docusaurus
deve estar no 
.gitignore
.

.docusaurus/
build/
.cache/

Não use diretamente​

Evite importar arquivos dessa pasta — use apenas as APIs do Docusaurus.

Em caso de erro estranho​

Execute:

npm run clear
npm install
npm start

Exemplo de arquivos​

routes.js​

export default [
  { path: '/', component: ComponentCreator('/', 'abc'), exact: true },
  { path: '/blog', component: ComponentCreator('/blog', 'def'), exact: true }
];

globalData.json​

{
  "docusaurus-plugin-content-docs": {
    "default": {
      "versions": [{ "name": "current", "label": "Next", "isLast": true }]
    }
  }
}

Conclusão​

O 

.docusaurus
é uma engrenagem essencial — mas invisível — do seu site. Não precisa se preocupar com ele no dia a dia, desde que:

  • Os arquivos do projeto estejam organizados
  • O 
    docusaurus.config.ts
    esteja bem configurado
  • Você use os comandos recomendados conforme necessário
O .docusaurus é uma engrenagem essencial — mas invisível — do seu site. Deixe o Docusaurus gerenciar automaticamente!
Curiosidade técnica

Quer entender como tudo funciona por trás dos bastidores? Explore o conteúdo dessa pasta em modo de desenvolvimento — mas sem alterar nada por lá 😉