Yaniv Editor Docs
Vue 3 + Tiptap 3 rich text editor with Full and Inline component shapes (current v0.1.2).
After installing peer dependencies, you do not need global Ant Design Vue registration in the host app (see Getting Started).
Quick Links
| I want to… | Start here |
|---|---|
| Get started in 5 minutes | Getting Started |
| Pick preset / enable features | Feature Matrix |
| Look up props | YanivEditor API |
| Notion-style block editing | Block Editing |
| Integrate AI | AI Assistance + AI Config |
| Overlays / z-index | Z-Index & Overlays |
| Understand code structure | Architecture |
| Try locally | Run pnpm dev → localhost:9527 |
| Live demo | yanivwang.github.io/yaniv-editor/examples/ |
Component Shapes
| Shape | Import | Use case |
|---|---|---|
| Full | @yanivjs/yaniv-editor | Documents, CMS, knowledge base |
| Inline | @yanivjs/yaniv-editor/inline | Comments, forms |
| AI | @yanivjs/yaniv-editor/ai | Optional AI extensions |
Full Editor Four-Axis API
vue
<YanivEditor
mode="edit"
preset="basic"
appearance="default"
color-mode="light"
:features="{ table: true }"
/>mode—edit | previewpreset—basic | full | notionappearance—default | word | notion | customcolorMode—light | dark | autofeatures— capability overrides
Documentation Structure
- Guide — integration, appearance, preview, i18n, integration props, z-index & overlays
- Features — per-capability docs and preset matrix
- API — component props, FeatureConfig, composables
- Contributing — project structure and architecture
Full architecture spec: repository root ARCHITECTURE.md.