https://github.com/kurusugawa-computer/markdown-copilot-vscode
OpenAI ChatGPT API client for VSCode
https://github.com/kurusugawa-computer/markdown-copilot-vscode
markdown openai vscode-extension
Last synced: 5 months ago
JSON representation
OpenAI ChatGPT API client for VSCode
- Host: GitHub
- URL: https://github.com/kurusugawa-computer/markdown-copilot-vscode
- Owner: kurusugawa-computer
- License: mit
- Created: 2024-02-10T07:48:28.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-19T11:12:19.000Z (over 1 year ago)
- Last Synced: 2024-08-20T10:38:21.401Z (over 1 year ago)
- Topics: markdown, openai, vscode-extension
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=kurusugawa-computer.markdown-copilot
- Size: 4.06 MB
- Stars: 8
- Watchers: 6
- Forks: 2
- Open Issues: 10
-
Metadata Files:
- Readme: README.ja.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/kurusugawa-computer/markdown-copilot-vscode/blob/main/README.md) [](https://github.com/kurusugawa-computer/markdown-copilot-vscode/blob/main/README.ja.md) [](https://github.com/kurusugawa-computer/markdown-copilot-vscode/blob/main/README.zh-cn.md)
# Markdown Copilot for Visual Studio Code
[](https://marketplace.visualstudio.com/items?itemName=kurusugawa-computer.markdown-copilot)
[](https://marketplace.visualstudio.com/items?itemName=kurusugawa-computer.markdown-copilot)
[](https://github.com/kurusugawa-computer/markdown-copilot-vscode/actions)
[](https://github.com/kurusugawa-computer/markdown-copilot-vscode)
[](https://github.com/kurusugawa-computer/markdown-copilot-vscode/graphs/contributors)
**Markdown Copilot** はVSCode用のOpenAI ChatGPT APIクライアントです。
Markdown Copilotを使用すると、OpenAI ChatGPT WebUIを完全に置き換えることができ、次のような優れた機能を提供します:
1. Model Context Protocolサーバを利用する
2. 会話履歴をMarkdownで保存する
3. 複数の会話を同時並行で行う
4. 会話を分岐させる
5. 会話履歴を編集して会話を続ける
6. 会話をもとにファイルに名前をつける
7. 会話にタイトルをつける
8. クリップボードの内容をファイルタイプに基づいて賢く貼り付ける
***注意***: この拡張機能を使用するには、OpenAI, Azure OpenAI, OpenRouterまたはローカルのOllamaインスタンスが必要です。設定方法：
- [OpenAI APIキー](https://help.openai.com/en/articles/4936850-where-do-i-find-my-api-key)
- [Azure OpenAI クイックスタート](https://learn.microsoft.com/en-us/azure/ai-services/openai/quickstart)
- [OpenRouter APIキー](https://openrouter.ai/keys): OpenAI, Claude, Gemini, Llama 3などをサポートしています。
- [ローカルOllamaインスタンス](https://ollama.com/): Llama 3.3, DeepSeek-R1, Phi-4, Mistral, Gemma 2などのモデルをローカルでサポートしています。
## 🌟 主な機能
### ⚡ Model Context Protocolサーバ利用
Markdown Copilotはオーバーライドツールで[Model Context Protocol(MCP)サーバ](https://github.com/modelcontextprotocol/servers)と連携して機能を拡張できます。
MCPサーバを介して外部ツールやデータソースにアクセスできるようにすることで、より強力で的確な会話を可能にします。
オーバーライドツールを使用するには、希望する設定を含むJSONコードブロックを `json copilot-tools` として含め、このブロックとテキストを一緒に選択し、コードアクションの提案から `💡 Markdown Copilot: 続ける` を使用します。
**例:** オーバーライドツールを使用して利用可能なツールを列挙する
~~~markdown
あなたが使えるツールを全て列挙して。
```json copilot-tools
["^copilot"]
```
~~~
MCPサーバの追加方法については、[Use MCP servers in VSCode: Add an MCP server](https://code.visualstudio.com/docs/copilot/chat/mcp-servers#_add-an-mcp-server)を参照してください。
### 🔀 並行編集
複数の自動編集を同時に実行し、ひとつの編集が完了するのを待たずに別の編集を開始できるため、作業速度が向上します。
### 📝 コンテキストに基づく編集
Markdown Copilotはコンテキストに基づいて選択したテキストに回答します。
使用するには、テキスト範囲を選択し、コードアクションの提案から `💡 Markdown Copilot: 続ける` を使用します。
または、クイックアクセスのためのショートカットキーを使用します:
| コマンド | Windows / Linux | Mac |
| :----------------: | :------------------------------: | :---------------------------: |
| `候補をトリガー` | Ctrl+Space または Ctrl+I | ⌃+Space または ⌘+I |
### ᝰ オーバーライドオプション
Markdown Copilotの挙動をオーバーライドオプションでカスタマイズします。これにより、文書内で直接、応答の長さやAIモデルなどの設定をコントロールできます。
オーバーライドオプションを使用するには、希望する設定を含むJSONまたはYAMLコードブロックをそれぞれ `json copilot-options` または `yaml copilot-options` として含め、このブロックとテキストを一緒に選択し、コードアクションの提案から `💡 Markdown Copilot: 続ける` を使用します。
**例:** カスタマイズされた応答の長さとモデルでMarkdown Copilotに自己紹介させる (JSON)
~~~markdown
自己紹介してください。
```json copilot-options
{"max_tokens":50,"model":"gpt-3.5-turbo"}
```
~~~
**例:** カスタマイズされた応答の長さとモデルでMarkdown Copilotに自己紹介させる (YAML)
~~~markdown
自己紹介してください。
```yaml copilot-options
max_tokens: 50
model: gpt-3.5-turbo
```
~~~
**例:** `o1-preview` モデルを利用する (JSON)
`o1-preview` モデルはシステムメッセージをサポートしていないので `**System(Override):**` を使ってシステムメッセージを空にします。
~~~markdown
**System(Override):**
**User:**
自己紹介してください。
```json copilot-options
{"model":"o1-preview","temperature":1}
```
~~~
**例:** ローカル Ollama の `llama2` モデルを使用する (JSON)
~~~markdown
Introduce yourself.
```json copilot-options
{"model":"llama2","baseURL":"http://localhost:11434/v1"}
```
~~~
**例:** ローカル Ollama の `llama2` モデルを使用する (YAML)
~~~markdown
Introduce yourself.
```yaml copilot-options
model: llama2
baseURL: http://localhost:11434/v1
```
~~~
他の設定オプションについては、[OpenAI API: Create chat completion](https://platform.openai.com/docs/api-reference/chat/create)を参照してください。
### 📛 ファイルに名前をつけて保存
Markdown Copilotはファイル内容をもとにファイルに名前を付けて保存できます。
使用するには、ファイルに名前を付けて保存したいエディタを選択して`Markdown Copilot: 名前をつけて保存...`コマンドを使用します。
または、次のショートカットキーを使用します:
| Windows / Linux | Mac |
| :-------------: | :---: |
| Ctrl+Shift+P > Name and Save As | ⌘+⇧+P > Name and Save As |
### 🏷️ アクティブコンテキストにタイトルを付ける
Markdown Copilotは会話履歴をもとに会話にタイトルを付けられます。
会話タイトルは`# Copilot Context: `で始まる行として表現します。
使用するには、タイトルを付けたいコンテキストにカーソルを移動して`Markdown Copilot: アクティブコンテキストにタイトルを付ける`コマンドを使用します。
または、次のショートカットキーを使用します:
| Windows / Linux | Mac |
| :-------------: | :---: |
| Ctrl+Shift+P > Title active context | ⌘+⇧+P > Title active context |
### 🪄 要約と新しいコンテキスト
Markdown Copilotでは現在のコンテキストを要約し、その要約に基づいて新しいコンテキストを開始できます。
この機能により、会話のコンテキストが長くなりすぎてモデルの処理能力を阻害しないようにしつつ、会話の要点を把握しやすくなります。
使用するには、要約したいコンテキストにカーソルを合わせた上で `Markdown Copilot: コンテキストを要約して新規開始` コマンドを使用してください。
| Windows / Linux | Mac |
| :-------------: | :---: |
| Ctrl+Shift+P > Summarize and New Context | ⌘+⇧+P > Summarize and New Context |
### 📋⤵ いい感じのテキストとして貼り付ける
Markdown Copilotはクリップボードの内容をファイルタイプに応じて賢くドキュメントに貼り付けることができます。
この機能により、貼り付けた内容が編集中のファイルにシームレスに統合され、不要なフォーマットの問題を回避できます。
使用するには、貼り付けたい場所を選択し`Markdown Copilot: Paste as Pretty Text`コマンドを使用します。
または、次のショートカットキーを使用します:
| Windows / Linux | Mac |
| :-------------: | :---: |
| Ctrl+Shift+P > Paste as pretty | ⌘+⇧+P > Paste as pretty |
### 📥 他のMarkdownファイルをインポート
Markdown Copilotは他のMarkdownファイルを現在の文書に簡単にインポートできます。
これにより、他のドキュメントの内容を参照したり、再利用したりすることが可能になります。
他のMarkdownファイルをインポートするには、`@import`ディレクティブを使用します。
このディレクティブに続けて、インポートしたいファイルのパスをダブルクォーテーションで囲んで指定します。
**相対パスの例:** 現在のファイルから相対的な位置にある`another-markdown.md`をインポートします。
```markdown
@import "path/to/another-markdown.md"
```
**絶対パスの例:** ワークスペースのルートディレクトリからの絶対パスを使用して`toplevel-markdown.md`をインポートします。
```markdown
@import "/toplevel-markdown.md"
```
現在の文書が未保存ときはファイルパスが確定していないため、必ず絶対パスを使用して他のMarkdownファイルを指定する必要があります。
### 🎛 コンテキストコントロール
コンテキストインデントと構文カラーを使用して、会話のコンテキストを階層的に管理し、視覚的にコンテキストを強調表示します。
#### ♯ Markdownにおけるコンテキスト表記
アクティブなコンテキストは、カーソル行からコンテキストインデントを遡って決定されます。
`# Copilot Context`で始まる行でコンテキストガードを強制できます。
`Then say "take care".`を選択して`💡 Markdown Copilot: 続ける` を使用すると、次の出力が得られます: `hello` → `good bye` → `take care`。
**より複雑な例:** コンテキストは`take care`行を跨いで継続します。
**発言者の指定:** 行頭に特定のMarkdown表記を配置することで発言者を指定できます。
| Markdown | 意味 |
| -------- | ---- |
| `**User:**` | ユーザ自身の発言であることを指定します |
| `**Copilot:**` | Markdown Copilotの発言であることを指定します |
| `**System(Override):**` | [システムメッセージ](https://platform.openai.com/docs/guides/prompt-engineering/tactic-ask-the-model-to-adopt-a-persona)を上書き指定します |
| `**System:**` | 追加の[システムメッセージ](https://platform.openai.com/docs/guides/prompt-engineering/tactic-ask-the-model-to-adopt-a-persona)を指定します |
#### ⤷ コンテキストインデント
コンテキストインデントレベルの編集を直感的なアクションで行えます。
テキストを選択し、コードアクションの提案から `💡 Markdown Copilot: コンテキスト行をインデント` または `💡 Markdown Copilot: コンテキスト行をアウトデント` を選択します。
または、次のショートカットキーを使用します:
| コマンド | Windows / Linux | Mac |
| :------------------: | :----------------------------------------------------------: | :-------------------------------------------------: |
| `Indent Quote Line` | Ctrl+Alt+L | ⌘+⌥+L |
| `Outdent Quote Line` | Ctrl+Alt+Shift+L | ⌘+⌥+⇧+L |
## 📋 前提条件
- OpenAI APIまたはAzure OpenAI Serviceへのアクセスが必要です。詳細については、[OpenAI API](https://openai.com/blog/openai-api)または[Azure OpenAIクイックスタート](https://learn.microsoft.com/ja-jp/azure/ai-services/openai/quickstart)をご覧ください。
- Visual Studio Codeがインストールされている必要があります。[Visual Studio Codeダウンロードページ](https://code.visualstudio.com/Download)からダウンロードしてください。
## 🔌 Markdown体験を強化する
次の拡張機能とMarkdown Copilotを組み合わせて、さらに強力なMarkdown体験を実現します:
- **[Markdown All in One]**:
包括的なMarkdownサポート(キーボードショートカット、目次、自動プレビューなど)。
- **[Snippets]**:
VS Codeでスニペットを過給 - エディタを終了せずにコードスニペットを管理できます。
- **[Markdown Preview Mermaid Support]**:
VS Codeの組み込みmarkdownプレビューにMermaidダイアグラムとフローチャートのサポートを追加します。
- **[Markdown Preview Enhanced]**:
Markdown Preview Enhanced は Visual Studio Code のスーパー強力なmarkdown 拡張機能です。 このプロジェクトの目標は、素晴らしい markdown 編集経験を提供することです。
- **[Markdown+Math]**:
LaTeX Mathを使用してMarkdownを強化します...マクロなどを含む。
## 🔄 変更履歴
詳細な更新については、[CHANGELOG](CHANGELOG.md)を参照してください。
## 🤝 参加する
- [GitHub Issues](https://github.com/kurusugawa-computer/markdown-copilot-vscode/issues)を通じてバグを報告したり、機能を提案してください。
- [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=kurusugawa-computer.markdown-copilot#review-details)でレビューを残してフィードバックを共有してください。
[Markdown All in One]: https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one
[Snippets]: https://marketplace.visualstudio.com/items?itemName=tahabasri.snippets
[Markdown Preview Mermaid Support]: https://marketplace.visualstudio.com/items?itemName=bierner.markdown-mermaid
[Markdown Preview Enhanced]: https://marketplace.visualstudio.com/items?itemName=shd101wyy.markdown-preview-enhanced
[Markdown+Math]: https://marketplace.visualstudio.com/items?itemName=goessner.mdmath