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.
Neste artigo vamos listar uma série de comandos que podem ser úteis durante o processo de criação, configuração ou publicação do seu Portal de Documentação.
Explore a possibilidade de customizar o seu portal com o Docusaurus.
O Docusaurus é uma ferramenta baseada em Markdown, focada em documentação técnica e para desenvolvedores. Ele permite a criação de portais totalmente customizáveis, ideais para documentar APIs, SDKs, bibliotecas e frameworks.
Este guia vai orientá-lo no processo de criação, configuração e publicação do seu portal de documentação utilizando o Docusaurus. Antes de continuar, acreditamos que seja importante você ter conhecimento sobre Git, Markdown, Javascript e CSS básico. Sugerimos que você faça o nosso tutorial de Git.
Criamos um assistente inteligente que auxilia os usuários em suas pesquisas. Com a funcionalidade "Pergunte à IA", as respostas são obtidas a partir de todo o conteúdo disponível nos documentos dentro do portal de documentação.
Chegamos a etapa final da construção do portal de documentação, a publicação em produção.
As atualizações são essenciais para garantir a segurança e o bom funcionamento do seu portal. Por isso, a NDL mantém um repositório modelo, onde realizamos as atualizações.