# Echo Editor

> Echo Editor is a fast, AI-ready WYSIWYG rich-text editor for Vue 3, built on Tiptap 3 and shadcn-vue. It ships 40+ extensions, bubble menus, a slash menu, Markdown, export, real-time collaboration, i18n and a plugin system.

## Documentation Sets

- [Echo Editor — full documentation](https://echo-editor.dev.elvedltd.com/llms-full.txt): The complete Echo Editor documentation in a single Markdown file.

## MCP Server

Search and read the Echo Editor documentation, list extensions and get setup code for Vue and Nuxt.

- [Echo Editor Docs](https://echo-editor.dev.elvedltd.com/mcp): Streamable HTTP endpoint — connect an MCP client to this URL to call the tools, resources and prompts exposed by this site.
- [MCP documentation](https://echo-editor.dev.elvedltd.com/ai/mcp): How to connect to this MCP server.

## Getting started

- [Introduction](https://echo-editor.dev.elvedltd.com/raw/getting-started/introduction.md): What Echo Editor is, what it ships with and how it is built.
- [Installation](https://echo-editor.dev.elvedltd.com/raw/getting-started/installation.md): Install the package and import the styles.
- [Quick start](https://echo-editor.dev.elvedltd.com/raw/getting-started/quick-start.md): Render your first editor with v-model in under a minute.
- [Nuxt](https://echo-editor.dev.elvedltd.com/raw/getting-started/nuxt.md): Use Echo Editor in a Nuxt 3 / Nuxt 4 application.
- [Migrating to v1](https://echo-editor.dev.elvedltd.com/raw/getting-started/migration.md): Upgrade from Echo Editor 0.x (Tiptap 2) to 1.x (Tiptap 3).

## Guide

- [Configuration](https://echo-editor.dev.elvedltd.com/raw/guide/configuration.md): Props, events, slots and the exposed editor instance of <EchoEditor>.
- [Toolbar & menus](https://echo-editor.dev.elvedltd.com/raw/guide/toolbar-and-menus.md): Customise the toolbar, bubble menu, slash menu, drag handle and menubar.
- [Markdown](https://echo-editor.dev.elvedltd.com/raw/guide/markdown.md): Read and write Markdown with v-model, commands and the official @tiptap/markdown parser.
- [Export](https://echo-editor.dev.elvedltd.com/raw/guide/export.md): Export documents to PDF, Markdown, HTML, RTF, plain text and JSON.
- [Images & uploads](https://echo-editor.dev.elvedltd.com/raw/guide/uploads.md): Upload images, videos and Word documents to your own storage.
- [AI assistant](https://echo-editor.dev.elvedltd.com/raw/guide/ai.md): Stream completions from any model into the inline AI menu.
- [Collaboration](https://echo-editor.dev.elvedltd.com/raw/guide/collaboration.md): Real-time collaborative editing with Y.js, remote carets and a presence list.
- [Internationalization](https://echo-editor.dev.elvedltd.com/raw/guide/i18n.md): 11 built-in languages, lazy loading, RTL and custom translations.
- [Theming](https://echo-editor.dev.elvedltd.com/raw/guide/theming.md): Accent colours, border radius, dark mode and CSS customisation.
- [Accessibility](https://echo-editor.dev.elvedltd.com/raw/guide/accessibility.md): Keyboard navigation, screen readers, reduced motion and touch support.
- [Performance](https://echo-editor.dev.elvedltd.com/raw/guide/performance.md): How Echo Editor stays fast and how to keep your integration fast.

## Extensions

- [Overview](https://echo-editor.dev.elvedltd.com/raw/extensions/overview.md): Every built-in extension, what it does and how to configure it.
- [Custom extensions](https://echo-editor.dev.elvedltd.com/raw/extensions/custom.md): Write your own extension with a toolbar button, or extend a built-in one.
- [Slash commands](https://echo-editor.dev.elvedltd.com/raw/extensions/slash-commands.md): Configure the "/" command menu and add your own commands.

## API

- [Editor instance](https://echo-editor.dev.elvedltd.com/raw/api/editor.md): Working with the underlying Tiptap editor — commands, content and events.
- [Composables](https://echo-editor.dev.elvedltd.com/raw/api/composables.md): useEditorState, useTheme, useLocale, useTiptapStore and useCollaborationUsers.
- [Plugins](https://echo-editor.dev.elvedltd.com/raw/api/plugins.md): Package extensions, toolbar buttons, slash commands and translations with definePlugin().
- [Utilities & types](https://echo-editor.dev.elvedltd.com/raw/api/utilities.md): Helper functions, components and TypeScript types exported by the package.

## AI & MCP

- [llms.txt](https://echo-editor.dev.elvedltd.com/raw/ai/llms-txt.md): Machine-readable documentation for LLMs and coding agents.
- [MCP server](https://echo-editor.dev.elvedltd.com/raw/ai/mcp.md): Connect Claude, Cursor, VS Code and other agents to the Echo Editor docs via the Model Context Protocol.

## Notes

- Package name on npm: `vue-echo-editor`. Import styles with `import 'vue-echo-editor/style.css'`.
- Collaboration lives in a separate entry point: `vue-echo-editor/collaboration`.
- Every page is also available as raw Markdown at `/raw/<path>.md`.