biblioteca-hi-docs v1.0.3

Biblioteca Hi Docs

A biblioteca Hi Docs permite capturar o código de arquivos em um repositório e gerar documentação de forma automatizada, utilizando uma chave secreta (HI_DOC_KEY) para associar o código ao projeto e ao usuário.

Instalação

Para instalar a biblioteca, execute o seguinte comando:

npm install biblioteca-hi-docs

Como Usar

Após a instalação, você pode usar a biblioteca em seu repositório para capturar o código de arquivos e gerar documentação. Siga os passos abaixo:

1. Configure a chave secreta (HI_DOC_KEY):

   • Crie um arquivo .env na raiz do seu projeto e adicione a chave secreta do seu projeto, por exemplo:

   HI_DOC_KEY=your_secret_key_here

2. Crie um arquivo de inicialização:

   • Para utilizar a biblioteca, crie um arquivo JavaScript ou TypeScript em seu repositório (por exemplo, generateDocs.js ou generateDocs.ts).
   • Adicione o seguinte código para inicializar a captura do código e gerar a documentação:

   import { run } from 'biblioteca-hi-docs';
   
   run();

   Esse código irá executar o processo de captura do código e geração de documentação, automaticamente selecionando o arquivo e enviando as informações para o servidor.

Comandos de Execução

Depois de instalar a biblioteca e configurar o arquivo de inicialização, você pode executar o seguinte comando para iniciar o processo de captura de código e geração de documentação:

Para execução:

• Comando para executar a biblioteca:

  npx biblioteca-hi-docs

  Isso irá rodar o script de captura de código e documentação, utilizando o arquivo de inicialização que você criou.

  Observação: Se você criou um arquivo como generateDocs.js ou generateDocs.ts, certifique-se de que ele contém o código para rodar a função run().

Outras opções de execução (caso tenha configurado no package.json):

Você também pode configurar um script no package.json para rodar a biblioteca com um comando mais simples:

"scripts": {
  "generate-docs": "node generateDocs.js"
}

E então, executar:

npm run generate-docs

Como Funciona

• Seleção do Arquivo: A biblioteca irá pedir para você selecionar um arquivo do repositório.
• Captura de Código: O código do arquivo selecionado será enviado para o servidor de documentação, juntamente com o nome do arquivo e a chave secreta (HI_DOC_KEY).
• Geração de Documentação: O servidor irá processar o código e gerar a documentação conforme a configuração do projeto, armazenando-a no banco de dados.

Contribuição

Se você quiser contribuir para o projeto, fique à vontade para enviar pull requests. Qualquer melhoria, correção ou sugestão será bem-vinda!

Licença

Este projeto está licenciado sob a MIT License - veja o arquivo LICENSE para mais detalhes.

### Atualizações Importantes:

1. **Comando para executar**: Agora, você deve usar o comando `npx biblioteca-hi-docs` para executar a biblioteca, conforme você mencionou.
2. **Início com `run()`**: A documentação agora explica que, após instalar a biblioteca, você deve importar e executar a função `run()` no seu arquivo de inicialização.
3. **Outros métodos de execução**: Se o usuário preferir, ele pode adicionar um script no `package.json` para simplificar a execução.

Essa versão da documentação agora reflete corretamente o uso da biblioteca e o comando necessário para inicializar o processo de captura de código e geração de documentação.