MarkyAI markdownGenerator

MarkyAI - Generador de rebajas (extensión de código VS)

Extendí Pipet-code-agent para crear un asistente de código de IA agregando una nueva función/comando para generar documentos README de GitHub bien formateados en Markdown en función de fragmentos de código seleccionados. Pipet Code Agent es una extensión de Visual Studio Code desarrollada por Google que aprovecha el poder de la API de Google Gemini para ayudar a los desarrolladores generando comentarios y reseñas para el código seleccionado.

Características

• Comentarios de revisión de código : genere automáticamente comentarios de revisión de código que identifiquen errores y sugieran mejoras.
• Comentarios de código : agregue comentarios explicativos a su código.
• Generador README de Markdown : genere documentos LÉAME de GitHub completos en formato Markdown según el código seleccionado.

Nuevo comando: Generador README de Markdown

El nuevo comando agregado a esta extensión le permite generar un documento README de GitHub bien estructurado en Markdown según el código seleccionado en el editor. El archivo README incluye encabezados, descripciones, ejemplos de código y otros formatos de Markdown relevantes.

Uso de ejemplo

1. Instale la extensión del agente Pipet Code

   Dado que la extensión aún no está publicada en VS Code Marketplace, puede probarla localmente siguiendo estos pasos:

   • Clona o descarga este repositorio.
   • Navegue hasta el directorio del proyecto en su terminal.

2. Instalar dependencias

   Instale las dependencias requeridas de Node.js usando npm.

   npm install

3. Ejecute la extensión en modo de depuración

   Abra el proyecto en Visual Studio Code y comience a depurar para ejecutar la extensión en una ventana de Extension Development Host.

   npm run vscode:prepublish

4. Configurar clave API

   Configure su clave API de Google Gemini en la configuración de VS Code.

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

5. Utilice el comando del generador README de Markdown

   • Seleccione el fragmento de código en su editor que desea documentar.
   • Abra la paleta de comandos ( Ctrl+Shift+P o Cmd+Shift+P ).
   • Escriba Pipet: Create README from Selected Text y seleccione el comando.

6. Ejemplo README generado

   A continuación se muestra un ejemplo de un archivo README generado basado en un fragmento de código seleccionado:

    # 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 " )

Contribuyendo

¡Las contribuciones a esta extensión son bienvenidas! Si tiene sugerencias para mejoras o nuevas funciones, no dude en abrir un problema o crear una solicitud de extracción en el repositorio de GitHub de Pipet Markdown Agent.

Licencia

Este proyecto está bajo la licencia Apache 2.0.

---