Skip to content

Latest commit

 

History

History
207 lines (133 loc) · 13.6 KB

README.ja.md

File metadata and controls

207 lines (133 loc) · 13.6 KB

en ja zh-cn

Markdown Copilot for Visual Studio Code

Version Downloads GitHub Workflow Status GitHub stars GitHub Contributors

Markdown Copilot はVSCode用のOpenAI ChatGPT APIクライアントです。

基本的な使用方法

Markdown Copilotを使用すると、OpenAI ChatGPT WebUIを完全に置き換えることができ、次のような優れた機能を提供します:

  1. 会話履歴をMarkdownで保存する
  2. 複数の会話を同時並行で行う
  3. 会話を分岐させる
  4. 会話履歴を編集して会話を続ける
  5. 会話をもとにファイルに名前をつける
  6. 会話にタイトルをつける

: この拡張機能を使用するには、OpenAIまたはAzure OpenAIのAPIキーが必要です。詳細については、OpenAI公式FAQまたはAzure OpenAIクイックスタートを参照してください。

🌟 主な機能

🔀 並行編集

複数の自動編集を同時に実行し、ひとつの編集が完了するのを待たずに別の編集を開始できるため、作業速度が向上します。

並行編集

🎛 コンテキストコントロール

引用インデントと構文カラーを使用して、会話のコンテキストを階層的に管理し、視覚的にコンテキストを強調表示します。

コンテキストコントロール

📝 コンテキストに基づく編集

Markdown Copilotはコンテキストに基づいて選択したテキストに回答します。

使用するには、テキスト範囲を選択し、コードアクションの提案から 💡 Markdown Copilot: 続ける を使用します。

コンテキストに基づく編集

または、クイックアクセスのためのショートカットキーを使用します:

コマンド Windows / Linux Mac
候補をトリガー Ctrl+Space または Ctrl+I +Space または +I

コンテキストに基づく編集のショートカット

♯ Markdownにおけるコンテキスト表記

アクティブなコンテキストは、カーソル行から引用インデントを遡って決定されます。 # Copilot Contextで始まる行でコンテキストガードを強制することができます。

例: take care

Then say "take care".を選択して💡 Markdown Copilot: 続ける を使用すると、次の出力が得られます: hellogood byetake care

例: take care

より複雑な例: コンテキストはtake care行を跨いで継続します。

例: see you again

発言者の指定: 行頭に特定のMarkdown表記を配置することで発言者を指定できます。

Markdown 意味
**User:** ユーザ自身の発言であることを指定します
**Copilot:** Markdown Copilotの発言であることを指定します
**System(Override):** システムメッセージを上書き指定します
**System:** システムメッセージを追加で指定します

ᝰ オーバーライドオプション

Markdown Copilotの挙動をオーバーライドオプションでカスタマイズします。これにより、文書内で直接、応答の長さやAIモデルなどの設定をコントロールできます。

オーバーライドオプションを使用するには、希望する設定を含むJSONコードブロックを json copilot-options として含め、このブロックとテキストを一緒に選択し、コードアクションの提案から 💡 Markdown Copilot: 続ける を使用します。

例: カスタマイズされた応答の長さとモデルでMarkdown Copilotに自己紹介させる

自己紹介してください。

```json copilot-options
{"max_tokens":50,"model":"gpt-3.5-turbo"}
```

例: o1-preview モデルを利用する

o1-previewo1-mini モデルはシステムメッセージをサポートしていないので **System(Override):** を使ってシステムメッセージを空にします。

**System(Override):**

**User:**
自己紹介してください。

```json copilot-options
{"model":"o1-preview","temperature":1}
```

他の設定オプションについては、OpenAI API: Create chat completionを参照してください。

📛 ファイルに名前をつけて保存

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ファイルをインポート

Markdown Copilotは他のMarkdownファイルを現在の文書に簡単にインポートできます。 これにより、他のドキュメントの内容を参照したり、再利用したりすることが可能になります。

他のMarkdownファイルをインポートするには、@importディレクティブを使用します。 このディレクティブに続けて、インポートしたいファイルのパスをダブルクォーテーションで囲んで指定します。

相対パスの例: 現在のファイルから相対的な位置にあるanother-markdown.mdをインポートします。

@import "path/to/another-markdown.md"

絶対パスの例: ワークスペースのルートディレクトリからの絶対パスを使用してtoplevel-markdown.mdをインポートします。

@import "/toplevel-markdown.md"

現在の文書が未保存ときはファイルパスが確定していないため、必ず絶対パスを使用して他のMarkdownファイルを指定する必要があります。

⤷ 引用インデント

引用インデントレベルの編集を直感的なアクションで行えます。

テキストを選択し、コードアクションの提案から 💡 Markdown Copilot: 引用行をインデント または 💡 Markdown Copilot: 引用行をアンインデント を使用します。

引用インデント

または、次のショートカットキーを使用します:

コマンド Windows / Linux Mac
Indent Quote Line Ctrl+Alt+L ++L
Outdent Quote Line Ctrl+Alt+Shift+L +++L

引用インデントのショートカット

📋 前提条件

🔌 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を参照してください。

🤝 参加する

  • GitHub Issuesを通じてバグを報告したり、機能を提案してください。
  • Visual Studio Marketplaceでレビューを残してフィードバックを共有してください。