MarkyAI markdownGenerator

MarkyAI - Gerador de Markdown (extensão de código VS)

Estendi o Pipet-code-agent para construir um assistente de código de IA com a adição de um novo recurso/comando para gerar documentos README do GitHub bem formatados no Markdown com base em trechos de código selecionados. O Pipet Code Agent é uma extensão do Visual Studio Code desenvolvida pelo Google que aproveita o poder da API Google Gemini para ajudar os desenvolvedores gerando comentários e análises para o código selecionado.

Características

• Comentários de revisão de código : gere automaticamente comentários de revisão de código que identificam bugs e sugerem melhorias.
• Comentários de código : adicione comentários explicativos ao seu código.
• Gerador README Markdown : Gere documentos README abrangentes do GitHub no formato Markdown com base no código selecionado.

Novo comando: Gerador README Markdown

O novo comando adicionado a esta extensão permite gerar um documento README GitHub bem estruturado em Markdown com base no código selecionado no editor. O README inclui cabeçalhos apropriados, descrições, exemplos de código e outras formatações Markdown relevantes.

Exemplo de uso

1. Instale a extensão do agente Pipet Code

   Como a extensão ainda não foi publicada no VS Code Marketplace, você pode testá-la localmente seguindo estas etapas:

   • Clone ou baixe este repositório.
   • Navegue até o diretório do projeto em seu terminal.

2. Instalar dependências

   Instale as dependências necessárias do Node.js usando npm.

   npm install

3. Execute a extensão no modo de depuração

   Abra o projeto no Visual Studio Code e comece a depurar para executar a extensão em uma janela Host de Desenvolvimento de Extensão.

   npm run vscode:prepublish

4. Configurar chave de API

   Configure sua chave de API do Google Gemini nas configurações do VS Code.

    // settings.json
   {
       "google.gemini.apiKey" : " your-api-key-here "
   }

5. Use o comando do gerador README Markdown

   • Selecione o trecho de código em seu editor que você deseja documentar.
   • Abra a paleta de comandos ( Ctrl+Shift+P ou Cmd+Shift+P ).
   • Digite Pipet: Create README from Selected Text e selecione o comando.

6. Exemplo README gerado

   Aqui está um exemplo de um README gerado com base em um trecho de código selecionado:

    # API Key Loader
   
   This script attempts to load the API key from the environment.
   
   ## Features
   - Securely load API keys
   - Easy to integrate
   
   ## Example Usage
   
   ``` python
   api_key = os.getenv( " GOOGLE_API_KEY " )

Contribuindo

Contribuições para esta extensão são bem-vindas! Se você tiver sugestões de melhorias ou novos recursos, sinta-se à vontade para abrir um problema ou criar uma solicitação pull no repositório GitHub do Pipet Markdown Agent.

Licença

Este projeto está licenciado sob a licença Apache 2.0.

---