Manter uma documentação clara, organizada e acessível é essencial para garantir que os usuários encontrem rapidamente as informações de que precisam. Este guia apresenta um conjunto de boas práticas para utilizar o Docusaurus de forma eficiente, garantindo padronização, qualidade e escalabilidade na documentação.
Um documento é uma página que pode ser criada em Markdown ou MDX, com o intuito de orientar o usuário a chegar no seu objetivo.
O recurso docs fornece uma maneira de organizar arquivos Markdown e MDX em um formato hierárquico.
Outro recurso muito útil é a Internacionalização. Ela serve para você publicar o seu portal em outros idiomas. Alguns elementos da tela já são traduzidos por padrão. Os idiomas padrões disponíveis são pt-BR (português do Brasil), en (inglês dos Estados Unidos) e es (espanhol da Espanha). Se você precisar de outro idioma, por favor entre em contato com o time NDL.
O menu lateral é um recurso essencial para organizar sua documentação de forma clara e intuitiva. Para facilitar esse processo, disponibilizamos exemplos de configuração e estruturação do conteúdo.
Neste artigo vamos explorar os recursos disponíveis em markdown para personalizar as suas documentações.
O versionamento é um ótimo recurso para manter o histórico das suas documentações, porém, na maioria das vezes você não precisa de versionamento, pois com o tempo, isso gera aumento no tempo de construção do site (build), além de gerar complexidade no código e duplicação de páginas.