# editorcn

> A collection of beautifully designed, accessible, and customizable rich text editor components. Built on Tiptap. Works with shadcn/ui. Use this index to discover the available documentation pages and markdown mirrors before browsing.

# Docs

- [Introduction](https://www.rtecn.space/docs.md): Rich text editor components for the shadcn/ui ecosystem.
- [Getting Started](https://www.rtecn.space/docs/getting-started.md): Get started with editorcn packages in your project.
- [Styling](https://www.rtecn.space/docs/styling.md): Customize the appearance of editorcn editors.
- [Customization](https://www.rtecn.space/docs/customization.md): See how to customize both editors through variants, CSS variables, className props, and more.

- **Registry**
- [Code Ownership](https://www.rtecn.space/docs/ownership.md): What code you own after installing editorcn and how it affects customization.
- [MCP](https://www.rtecn.space/docs/mcp.md): Learn how to use the shadcn MCP (Model Context Protocol) server with editorcn.
- [Registry](https://www.rtecn.space/docs/registry.md): Install editorcn packages via the shadcn registry.

- **Editor (Toolbar)**
- @editorcn/editor
  - [RichTextEditor](https://www.rtecn.space/docs/editor.md): Tiptap-based rich text editor with toolbar controls.
  - [Serialization format](https://www.rtecn.space/docs/editor/serialization-format.md): How editor content is serialized and how to handle it.

- **Block Editor (Blocks)**
- @editorcn/block-editor
  - [BlockEditor](https://www.rtecn.space/docs/block-editor.md): Notion-style block-based rich text editor with slash commands and bubble menu.
  - [Serialization format](https://www.rtecn.space/docs/block-editor/serialization-format.md): How block editor content is serialized.

## Machine-readable Resources

- [Full documentation](https://www.rtecn.space/llms-full.txt)
- [Homepage markdown](https://www.rtecn.space/llms.md/content.md)
- [OpenAPI description](https://www.rtecn.space/openapi.json)
- [API catalog](https://www.rtecn.space/.well-known/api-catalog)
- [Agent skill](https://www.rtecn.space/.well-known/agent-skills/site-skill.md)
- [shadcn MCP server documentation](https://ui.shadcn.com/docs/mcp)