MarkyAI markdownGenerator

MarkyAI — генератор Markdown (расширение кода VS)

Я расширил Pipet-code-agent для создания помощника по кодированию AI, добавив новую функцию/команду для создания хорошо отформатированных документов README GitHub в Markdown на основе выбранных фрагментов кода. Агент Pipet Code — это расширение кода Visual Studio, разработанное Google, которое использует возможности API Google Gemini, помогая разработчикам создавать комментарии и обзоры для выбранного кода.

Функции

• Комментарии к проверке кода : автоматически генерируйте комментарии к проверке кода, которые выявляют ошибки и предлагают улучшения.
• Комментарии к коду : добавьте пояснительные комментарии к вашему коду.
• Генератор Markdown README : создавайте полные документы README GitHub в формате Markdown на основе выбранного кода.

Новая команда: генератор Markdown README

Новая команда, добавленная в это расширение, позволяет генерировать хорошо структурированный документ README GitHub в Markdown на основе кода, выбранного в редакторе. README включает соответствующие заголовки, описания, примеры кода и другое соответствующее форматирование Markdown.

Пример использования

1. Установите расширение агента Pipet Code.

   Поскольку расширение еще не опубликовано на VS Code Marketplace, вы можете протестировать его локально, выполнив следующие действия:

   • Клонируйте или загрузите этот репозиторий.
   • Перейдите в каталог проекта в вашем терминале.

2. Установить зависимости

   Установите необходимые зависимости Node.js с помощью npm.

   npm install

3. Запустите расширение в режиме отладки

   Откройте проект в Visual Studio Code и начните отладку, чтобы запустить расширение в окне узла разработки расширений.

   npm run vscode:prepublish

4. Настроить ключ API

   Настройте ключ API Google Gemini в настройках VS Code.

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

5. Используйте команду генератора Markdown README

   • Выберите в редакторе фрагмент кода, который вы хотите задокументировать.
   • Откройте палитру команд ( Ctrl+Shift+P или Cmd+Shift+P ).
   • Введите Pipet: Create README from Selected Text и выберите команду.

6. Сгенерированный пример README

   Вот пример созданного README на основе выбранного фрагмента кода:

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

Содействие

Вклад в это расширение приветствуется! Если у вас есть предложения по улучшениям или новым функциям, смело открывайте проблему или создайте запрос на включение в репозитории Pipet Markdown Agent GitHub.

Лицензия

Этот проект распространяется по лицензии Apache 2.0.

---