Markdown Copilot for Visual Studio Code

Markdown Copilot is an OpenAI ChatGPT API client for VSCode.

Markdown Copilot enables you to fully replace the OpenAI ChatGPT WebUI, offering superior features such as:

1. Saving conversation histories in Markdown
2. Conducting multiple conversations simultaneously
3. Branching out conversations
4. Editing previous conversations at any point and continuing the conversation
5. Nameing files based on conversations
6. Titling conversations

Note: An OpenAI or Azure OpenAI API key is required to use this extension. For more information, please refer to the OpenAI official FAQ or Azure OpenAI Quickstart.

🌟 Key Features

🔀 Parallel Editing

Execute multiple auto-edits simultaneously, enhancing your productivity by not having to wait for one edit to complete before starting another.

🎛 Context Control

Manage conversational contexts hierarchically, using quote indentation and syntax colors for visual context highlighting.

📝 Contextual Editing

Markdown Copilot answers to selected text based on context.

To use, select a text range and choose 💡 Markdown Copilot: Continue from the code action proposals.

Or use shortcuts for quick access:

♯ Context Notation in Markdown

The active context is determined by tracing back the quote indent from the cursor line. Can force a context guard with a line starting with # Copilot Context.

If you select Then say "take care". and choose 💡 Markdown Copilot: Continue, you will get the following output: hello → good bye → take care.

More complex example: the context continues across take care line.

Specifying a speaker: You can specify a speaker by placing a special Markdown notation at the beginning of a line.

ᝰ Override Options

Customize Markdown Copilot's behavior with override options. This allows you to control settings like response length or the AI model directly within your document.

To use override options, simply include a JSON code block labeled json copilot-options with your desired settings, then select this block along with your text and choose 💡 Markdown Copilot: Continue from the code action proposals.

Example: Let Markdown Copilot introduce itself with customized response length and model

Introduce yourself.

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

For more configuration options, please refer to the [OpenAI API: Create chat completion](https://platform.openai.com/docs/api-reference/chat/create).

### 📛 Name and Save File

Markdown Copilot allows you to name and save a file based on its contents.

To use, select the editor you want to name and save, and use the `Markdown Copilot: Name and Save As...` command.

Or use shortcuts for quick access:

| Windows / Linux | Mac |
| :-------------: | :---: |
| <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> > <kbd>Name and Save As</kbd> | <kbd>⌘</kbd>+<kbd>⇧</kbd>+<kbd>P</kbd> > <kbd>Name and Save As</kbd> |

### 🏷️ Titling the Active Context

Markdown Copilot allows you to title a conversation based on the conversation history.
Conversation titles are represented as lines beginning with `# Copilot Context: `.

To use, move the cursor to the context you want to title and use the `Markdown Copilot: Title active context` command.

Or use shortcuts for quick access:

| Windows / Linux | Mac |
| :-------------: | :---: |
| <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> > <kbd>Title active context</kbd> | <kbd>⌘</kbd>+<kbd>⇧</kbd>+<kbd>P</kbd> > <kbd>Title active context</kbd> |

### 📥 Import Other Markdown Files

Markdown Copilot allows you to easily import other Markdown files into your current document.
This enables you to reference or reuse content from other documents.

To import another Markdown file, use the `@import` directive followed by the path to the file you want to import, enclosed in double quotes.

**Example with a relative path:** Import `another-markdown.md` located at a relative position from the current file.

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

Example with an absolute path: Use an absolute path from the root directory of the workspace to import toplevel-markdown.md.

@import "/toplevel-markdown.md"

When the current document is unsaved and thus lacks a confirmed file path, you must use an absolute path to specify other Markdown files to be imported.

⤷ Quote Indentation

Simplify the editing of quote indentation levels with intuitive actions.

Select text and choose 💡 Markdown Copilot: Indent Quote Line or 💡 Markdown Copilot: Outdent Quote Line from code action proposals.

Or use these shortcuts:

📋 Prerequisites

• Access to the OpenAI API or Azure OpenAI Service is necessary. For details, visit OpenAI API or Azure OpenAI Quickstart.
• Visual Studio Code must be installed. Download it from the Visual Studio Code download page.

🔌 Enhance Your Markdown Experience

Combine Markdown Copilot with these extensions for an even more powerful Markdown experience:

• Markdown All in One: Comprehensive Markdown support (keyboard shortcuts, table of contents, auto preview, and more).
• Snippets: Supercharge your Snippets in VS Code — Manage your code snippets without quitting your editor.
• Markdown Preview Mermaid Support: Adds Mermaid diagram and flowchart support to VS Code's built-in markdown preview.
• Markdown Preview Enhanceded): Markdown Preview Enhanced is a SUPER POWERFUL markdown extension for Visual Studio Code. The goal of this project is to bring you a wonderful markdown writing experience.
• Markdown+Math: Enhance your Markdown with LaTeX Math ... including macros and more.

🔄 Changelog

For detailed updates, refer to the CHANGELOG.

🤝 Get Involved

• Report bugs or suggest features via GitHub Issues.
• Share your feedback by leaving a review on the Visual Studio Marketplace.