MarkyAI markdownGeneratorダウンロード - MarkyAI markdownGeneratorソースコードのダウンロード

MarkyAI markdownGenerator

AI ソースコード

1.0.0

ダウンロード

MarkyAI - マークダウンジェネレーター (VS コード拡張機能)

Pipet-code-agent を拡張して、選択したコードスニペットに基づいて Markdown で適切にフォーマットされた GitHub README ドキュメントを生成するための新しい機能/コマンドを追加して AI コードアシスタントを構築しました。 Pipet Code Agent は、Google が開発した Visual Studio Code 拡張機能であり、Google Gemini API の機能を利用して、選択したコードに対するコメントやレビューを生成することで開発者を支援します。

画像例

特徴

コードレビューコメント: バグを特定し、改善を提案するコードレビューコメントを自動的に生成します。
コードコメント: コードに説明的なコメントを追加します。
Markdown README Generator : 選択したコードに基づいて包括的な GitHub README ドキュメントを Markdown 形式で生成します。

新しいコマンド: Markdown README ジェネレーター

この拡張機能に追加された新しいコマンドを使用すると、エディターで選択したコードに基づいて、適切に構造化された GitHub README ドキュメントを Markdown で生成できます。 README には、適切なヘッダー、説明、コード例、その他の関連するマークダウン形式が含まれています。

使用例

Pipet コードエージェント拡張機能のインストール
この拡張機能はまだ VS Code Marketplace で公開されていないため、次の手順に従ってローカルでテストできます。
- このリポジトリを複製またはダウンロードします。
- ターミナルでプロジェクトディレクトリに移動します。
依存関係のインストール
npm を使用して、必要な Node.js 依存関係をインストールします。
```
npm install
```
拡張機能をデバッグモードで実行する
Visual Studio Code でプロジェクトを開き、デバッグを開始して、拡張機能開発ホストウィンドウで拡張機能を実行します。
```
npm run vscode:prepublish
```

APIキーの設定

VS Code 設定で Google Gemini API キーを設定します。

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

Markdown README ジェネレーターコマンドを使用する
- 文書化するコードスニペットをエディターで選択します。
- コマンドパレットを開きます ( Ctrl+Shift+PまたはCmd+Shift+P )。
- Pipet: Create README from Selected Textと入力し、コマンドを選択します。

生成された 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 " )