llms.txt
# slash-editor
- [Introduction](/docs): Notion-style block editor for React, headless core on Tiptap/ProseMirror, UI you own.
- Getting Started
- [Installation](/docs/getting-started/installation): Install the headless packages, their peer dependencies, and the .slash-content styling every editor instance needs.
- [Quick Start](/docs/getting-started/quick-start): Wire up a minimal editor with the slash menu in a few lines.
- [shadcn Registry](/docs/getting-started/registry): Add the slash-editor registry once, then install any UI piece with shadcn add.
- [Comparison](/docs/getting-started/comparison): How slash-editor relates to Tiptap, BlockNote, Novel, and Plate — licensing, UI delivery, engine, and features.
- Components
- [Slash Menu](/docs/components/slash-menu): The '/' block-insert command palette — shadcn Command in an anchored Popover, driven by useSlashMenu.
- [Bubble Toolbar](/docs/components/bubble-toolbar): Selection-anchored inline formatting toolbar (bold, italic, strike, code), driven by useBubbleToolbar.
- [Block Handle](/docs/components/block-handle): Gutter hover handle for insert-below, drag-to-reorder, and the block context menu. Requires a TooltipProvider ancestor.
- [Mention Menu](/docs/components/mention-menu): Async '@'-mention search surface — shadcn Command in a Popover, driven by useMention.
- [Emoji Menu](/docs/components/emoji-menu): Emoji picker for the `:shortcode:` trigger — shadcn Command in a Popover, driven by useEmoji.
- [Link Editor Popover](/docs/components/link-editor-popover): Inline link create/edit popover with href input, open, and remove, driven by useLinkEditor.
- [Comment Panel](/docs/components/comment-panel): Sidebar comment threads anchored to a selection, backed by a host-provided CommentThreadStore.
- [Presence Avatars](/docs/components/presence-avatars): Connected collaborators as a row of colored initials, driven by usePresence against any awareness-shaped provider.
- [Table of Contents](/docs/components/table-of-contents): A heading outline of the live document with an active row that follows the caret or the scroll position.
- [Pages](/docs/components/pages): Node views, header, tree, breadcrumb and backlinks for host-owned sub-pages.
- [Media & AI Node Views](/docs/components/node-views): ReactNodeViewRenderer targets for image, file, video, embed, and an AI block — upload/retry chrome shared across image/file/video.
- [Mermaid Node View](/docs/components/mermaid-node-view): Renders the core mermaid node as a diagram themed from your shadcn tokens — click it to edit the source with a live preview.
- [Code Block Node View](/docs/components/code-block-node-view): Syntax-highlighted code blocks (lowlight) with a language selector, themed from your shadcn tokens.
- [slash-editor Kit](/docs/components/slash-editor-kit): Every slash-editor UI piece in one install — slash menu, bubble toolbar, block handle, mention menu, emoji menu, link editor, comment panel, presence avatars, media/AI node views, the Mermaid node view, and the code block node view.
- Guides
- [Slash Items](/docs/guides/slash-items): Custom slash commands, ranking, aliases, and groups.
- [Block Kit](/docs/guides/block-kit): Every createBlockKit() option — what ships by default, and how to opt a block out.
- [Upload Adapter](/docs/guides/upload-adapter): The UploadAdapter contract shared by image, file, and video nodes — plus retry.
- [Mentions](/docs/guides/mentions): Wiring an async @-mention provider.
- [Pages](/docs/guides/pages): Notion-style sub-pages — a sub-page block, inline page links, and a host-owned page store.
- [Emoji](/docs/guides/emoji): The `:shortcode:` picker and the /emoji slash item.
- [Localization](/docs/guides/localization): Translate slash items, placeholders, block menu actions, and toolbar labels with the `messages` option.
- [AI Stream Adapter](/docs/guides/ai-stream-adapter): The StreamAdapter contract behind AI actions.
- [Collaboration](/docs/guides/collaboration): Real-time collaboration over Yjs — self-hosted, no paid tier.
- [Comments](/docs/guides/comments): The comment mark plus a bring-your-own CommentThreadStore.
- [Markdown](/docs/guides/markdown): Exporting a document to .md and importing it back.
- [Read-Only Documents](/docs/guides/read-only): useSlashEditor({ editable: false }) for a viewer — what stays interactive, what goes inert by design, and the aiBlock caveat.
- [Migrating](/docs/guides/migrating): Moving existing content and editor setup from Tiptap, Novel, BlockNote, or Plate.
- API Reference
- [@slash-editor/core](/docs/api/core): Extensions, schema, commands, and serializers. No React, no CSS.
- [@slash-editor/react](/docs/api/react): Hooks and headless primitives over @tiptap/react.
