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. Using Model Context Protocol Servers
2. Saving conversation histories in Markdown
3. Conducting multiple conversations simultaneously
4. Branching out conversations
5. Editing previous conversations at any point and continuing the conversation
6. Nameing files based on conversations
7. Titling conversations
8. Pasting clipboard content intelligently based on file type

Note: An OpenAI, Azure OpenAI, OpenRouter, or local Ollama instance is required to use this extension. For configuration:

• OpenAI API Key
• Azure OpenAI Quickstart
• OpenRouter API Keys: supports OpenAI, Claude, Gemini, Llama 3, and more.
• Local Ollama instance: supports Llama 3.3, DeepSeek-R1, Phi-4, Mistral, Gemma 2, and other models, locally.

🌟 Key Features

⚡ Model Context Protocol Server Using

Markdown Copilot can extend its functionality through Model Context Protocol (MCP) servers. By enabling access to external tools and data sources via MCP servers, you can have more powerful and accurate conversations.

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

Example: List available tools using override tools

List all tools you can use.

```json copilot-tools
["^copilot"]
```

For instructions on adding an MCP server, please refer to the Use MCP servers in VS Code: Add an MCP server.

🔀 Parallel Editing

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

📝 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:

ᝰ 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 or YAML code block labeled json copilot-options or yaml copilot-options respectively 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 (JSON)

Introduce yourself.

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

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

Introduce yourself.

```yaml copilot-options
max_tokens: 50
model: gpt-3.5-turbo
```

Example: Using the o1-preview model (JSON)

The o1-preview model do not support system messages, so we will use **System(Override):** to clear the system messages.

**System(Override):**

**User:**
Introduce yourself.

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

Example: Using local Ollama with llama2 model (JSON)

Introduce yourself.

```json copilot-options
{"model":"llama2","baseURL":"http://localhost:11434/v1"}
```

Example: Using local Ollama with llama2 model (YAML)

Introduce yourself.

```yaml copilot-options
model: llama2
baseURL: http://localhost:11434/v1
```

For more configuration options, please refer to the OpenAI API: Create chat completion.

📛 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:

🏷️ 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:

🪄 Summarize and New Context

Markdown Copilot allows you to summarize the current context and start a new context based on the summary. This feature helps prevent the conversation context from becoming excessively long, which can impair the model's ability to process the conversation effectively, while also making it easier for you to grasp the conversation's essence.

To use, move the cursor to the context you want to summarize and use the Markdown Copilot: Summarize and New Context command.

📋⤵ Paste as Pretty Text

Markdown Copilot allows you to paste clipboard content into your document in an intelligent way, adapting to the file type. This feature ensures that pasted content integrates seamlessly into your editing files, avoiding unnecessary formatting issues.

To use this feature, select the location where you want to paste the content and use the Markdown Copilot: Paste as Pretty Text command.

Or use shortcuts for quick access:

📥 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.

@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.

🎛 Context Control

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

♯ Context Notation in Markdown

The active context is determined by tracing back the context 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.

⤷ Context Indentation

Simplify the editing of context indentation levels with intuitive actions.

Select text and choose 💡 Markdown Copilot: Indent Context Line or 💡 Markdown Copilot: Outdent Context 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 Enhanced: 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.