{"id":20564852,"url":"https://github.com/jefferson-calmon/codocx","last_synced_at":"2025-05-16T14:07:03.697Z","repository":{"id":254136795,"uuid":"845601920","full_name":"jefferson-calmon/codocx","owner":"jefferson-calmon","description":"A ferramenta mais simples e fácil de usar para automatizar documentação de código","archived":false,"fork":false,"pushed_at":"2024-10-16T20:02:24.000Z","size":59,"stargazers_count":315,"open_issues_count":5,"forks_count":35,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-12T11:11:35.307Z","etag":null,"topics":["ai","cli","code","docs","zero-config"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jefferson-calmon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-21T15:02:20.000Z","updated_at":"2025-03-26T11:32:18.000Z","dependencies_parsed_at":"2024-10-18T16:54:10.815Z","dependency_job_id":null,"html_url":"https://github.com/jefferson-calmon/codocx","commit_stats":null,"previous_names":["jefferson-calmon/codocx"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jefferson-calmon%2Fcodocx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jefferson-calmon%2Fcodocx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jefferson-calmon%2Fcodocx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jefferson-calmon%2Fcodocx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jefferson-calmon","download_url":"https://codeload.github.com/jefferson-calmon/codocx/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254544146,"owners_count":22088807,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","cli","code","docs","zero-config"],"created_at":"2024-11-16T04:29:14.754Z","updated_at":"2025-05-16T14:07:03.676Z","avatar_url":"https://github.com/jefferson-calmon.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Codocx\n\nCodocx é 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.\n\n## Visão Geral\n\nA 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.\n\n## Execução via CLI\n\nA 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.\n\n### Como Usar a CLI\n\n1. **Instale a CLI globalmente:**\n\n    ```bash\n    npm install -g codocx\n    ```\n\n2. **Gere a documentação:**\n\n    Navegue até o diretório do seu projeto e execute:\n\n    ```bash\n    codocx -p \u003cDIR_PROJECT\u003e\n    ```\n\n    Você pode substituir `\u003cDIR_PROJECT\u003e` pelo caminho do diretório do projeto. Se não fornecer nenhum caminho, a CLI usará o diretório atual.\n\n### Ignorando Arquivos\n\nCaso queira excluir determinados arquivos ou diretórios da geração da documentação, você pode configurar isso editando o arquivo `src/constants/index.ts`.\n\n## Requisitos\n\nAntes de começar, certifique-se de que sua máquina atenda aos seguintes requisitos:\n\n-   Node.js (versão 14 ou superior)\n-   npm (gerenciador de pacotes do Node.js)\n\n## Como Rodar o Projeto Manualmente\n\nSe preferir rodar o Codocx localmente, siga estas etapas:\n\n1. **Clone o repositório:**\n\n    ```bash\n    git clone \u003cURL_DO_REPOSITORIO\u003e\n    cd codocx\n    ```\n\n2. **Instale as dependências:**\n\n    ```bash\n    npm install\n    ```\n\n3. **Inicie o projeto:**\n\n    ```bash\n    npm start\n    ```\n\n## Contribuindo\n\nContribuições são bem-vindas! Se você deseja contribuir com o Codocx, siga estas etapas:\n\n1. **Fork o repositório.**\n2. **Crie uma branch para sua feature ou correção de bug:**\n\n    ```bash\n    git checkout -b minha-nova-feature\n    ```\n\n3. **Faça suas alterações e commit:**\n\n    ```bash\n    git commit -m \"Adiciona nova feature\"\n    ```\n\n4. **Envie para o repositório remoto:**\n\n    ```bash\n    git push origin minha-nova-feature\n    ```\n\n5. **Abra um Pull Request.**\n\nPor favor, certifique-se de que suas contribuições estão de acordo com o código de conduta do projeto.\n\n## Licença\n\nEste projeto está licenciado sob a Licença MIT. Consulte o arquivo [LICENSE](./LICENSE) para mais informações.\n\n## Notas Finais\n\nTodos os commits deste repositório foram gerados utilizando o [GiteAI](https://giteai.dev), uma ferramenta que automatiza a criação de mensagens de commit, garantindo consistência e clareza no histórico do projeto.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjefferson-calmon%2Fcodocx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjefferson-calmon%2Fcodocx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjefferson-calmon%2Fcodocx/lists"}