Codocx é uma ferramenta de linha de comando (CLI) simples e eficiente para automatizar a geração de documentação de qualquer projeto de software, independentemente da linguagem de programação ou stack tecnológica utilizada.
A documentação é essencial, mas muitas vezes negligenciada. Codocx resolve esse problema ao permitir que desenvolvedores gerem documentação atualizada e acessível com apenas alguns comandos. A ferramenta é compatível com qualquer linguagem de programação, garantindo flexibilidade e eficiência em qualquer ambiente de desenvolvimento.
A CLI do Codocx foi projetada para ser extremamente fácil de usar, permitindo a geração de documentação diretamente a partir da estrutura de código do seu projeto.
-
Instale a CLI globalmente:
npm install -g codocx
-
Gere a documentação:
Navegue até o diretório do seu projeto e execute:
codocx -p <DIR_PROJECT>
Você pode substituir
<DIR_PROJECT>pelo caminho do diretório do projeto. Se não fornecer nenhum caminho, a CLI usará o diretório atual.
Caso queira excluir determinados arquivos ou diretórios da geração da documentação, você pode configurar isso editando o arquivo src/constants/index.ts.
Antes de começar, certifique-se de que sua máquina atenda aos seguintes requisitos:
- Node.js (versão 14 ou superior)
- npm (gerenciador de pacotes do Node.js)
Se preferir rodar o Codocx localmente, siga estas etapas:
-
Clone o repositório:
git clone <URL_DO_REPOSITORIO> cd codocx
-
Instale as dependências:
npm install
-
Inicie o projeto:
npm start
Contribuições são bem-vindas! Se você deseja contribuir com o Codocx, siga estas etapas:
-
Fork o repositório.
-
Crie uma branch para sua feature ou correção de bug:
git checkout -b minha-nova-feature
-
Faça suas alterações e commit:
git commit -m "Adiciona nova feature" -
Envie para o repositório remoto:
git push origin minha-nova-feature
-
Abra um Pull Request.
Por favor, certifique-se de que suas contribuições estão de acordo com o código de conduta do projeto.
Este projeto está licenciado sob a Licença MIT. Consulte o arquivo LICENSE para mais informações.
Todos os commits deste repositório foram gerados utilizando o GiteAI, uma ferramenta que automatiza a criação de mensagens de commit, garantindo consistência e clareza no histórico do projeto.
