Uma das tarefas mais importantes na criação de software é a documentação, infelizmente para nós que desenvolvemos este trabalho às vezes parece enfadonho, mas não é segredo para ninguém que uma boa documentação pode ser o ponto de sucesso de qualquer ferramenta, uma vez que Seja pela ajuda que é dada aos usuários para entender o correto funcionamento do aplicativo ou pelas informações que são fornecidas a outros desenvolvedores para melhorá-lo.
Existem aplicativos muito bons que nos permitem documentar nossos projetos de forma simples, alguns tendem a oferecer mais do que realmente queremos e outros requerem instalações complexas, um ferramenta para documentar projetos que cumpre e é bastante simples de usar e instalar é o Docusaurus.
O que é Docusaurus?
Docussauro é um projeto para construir, implementar e manter documentação da web de ferramentas de código aberto, permite usar a linguagem Redução de preço Para escrever a documentação que mais tarde será publicada como um site html, da mesma forma, a ferramenta nos permite estender e customizar o design do nosso site de documentação com o uso do React.
Em geral, esta ferramenta de código aberto desenvolvida pela equipe de programação do Facebook nos permite criar facilmente sites bonitos e leves onde podemos exibir adequadamente a documentação de qualquer projeto.
A ferramenta está equipada com funcionalidades para o correto versionamento de documentos, um buscador avançado, a possibilidade de documentar e redesenhar nosso site de documentação em tempo real, integração com traduções e muitos outros recursos que o ajudarão a se preocupar menos em documentar ou antes em fazer o processo de documentação mais fácil e com um acabamento mais agradável.
A facilidade de uso do Docusaurus pode ser vista no seguinte gif distribuído por seus desenvolvedores
Como instalar o Docusaurus?
O objetivo principal do Docusaurus é ser a ferramenta definitiva para documentar aplicativos open source hospedados no github, por isso é realmente fácil instalar e executar seu site de documentação nesta plataforma.
Para começar a desfrutar do Docusaurus no Github, basta seguir os passos indicados pela equipe de desenvolvimento e que citamos a seguir:
- Vá para a raiz do diretório do repositório GitHub, onde criará os documentos e executará os seguintes comandos:
yarn global add docusaurus-init
ornpm install --global docusaurus-init
docusaurus-init
O resultado final será a criação de um arquivo e estrutura de diretório conforme mostrado abaixo:
Bug interessante para tentar!