mirror of
https://github.com/logancyang/obsidian-copilot.git
synced 2026-07-22 07:50:24 +00:00
30 lines
1.9 KiB
Markdown
30 lines
1.9 KiB
Markdown
|
# Copilot for Obsidian — Documentation
|
||
|
|
|
||
|
|
Welcome to the official documentation for **Copilot for Obsidian**, an AI-powered assistant plugin that brings the power of large language models directly into your note-taking workflow.
|
||
|
|
|
||
|
|
## Table of Contents
|
||
|
|
|
||
|
|
| Document | What it covers |
|
||
|
|
|---|---|
|
||
|
|
| [Getting Started](getting-started.md) | Installation, first-time setup, opening the chat panel, keyboard shortcuts |
|
||
|
|
| [Chat Interface](chat-interface.md) | Chat modes, sending messages, history, settings, auto-compact |
|
||
|
|
| [LLM Providers](llm-providers.md) | All 16+ supported providers and how to set them up |
|
||
|
|
| [Models and Parameters](models-and-parameters.md) | Chat models, embedding models, temperature, max tokens, and other parameters |
|
||
|
|
| [Context and Mentions](context-and-mentions.md) | Active note context, @-mentions, URLs, tags, and the web viewer |
|
||
|
|
| [Custom Commands](custom-commands.md) | Creating and using preset prompts, template variables, Quick Command, Quick Ask |
|
||
|
|
| [Vault Search and Indexing](vault-search-and-indexing.md) | Lexical search, semantic search, index management, exclusions |
|
||
|
|
| [Agent Mode and Tools](agent-mode-and-tools.md) | Autonomous agent, all 13 tools, file editing, web search |
|
||
|
|
| [Projects](projects.md) | Focused workspaces with isolated context, model, and chat history |
|
||
|
|
| [System Prompts](system-prompts.md) | Customizing AI behavior with built-in and custom system prompts |
|
||
|
|
| [Copilot Plus and Self-Host](copilot-plus-and-self-host.md) | Copilot Plus features, memory system, self-host mode, Miyo |
|
||
|
|
| [Troubleshooting and FAQ](troubleshooting-and-faq.md) | Common errors, provider-specific issues, performance, FAQ |
|
||
|
|
|
||
|
|
## Quick Start
|
||
|
|
|
||
|
|
1. Install Copilot from Obsidian Community Plugins
|
||
|
|
2. Add an API key in Settings → Copilot → Basic → API Keys
|
||
|
|
3. Open the chat panel with the robot icon in the left ribbon
|
||
|
|
4. Start chatting!
|
||
|
|
|
||
|
|
For a full walkthrough, see [Getting Started](getting-started.md).
|