https://github.com/yiitap/yiitap
An AI powered, Notion-style WYSIWYG rich-text block-based editor. 🍀
https://github.com/yiitap/yiitap
block editor notion react ts typescript vue wysiwyg wysiwyg-editor yiitap
Last synced: 3 months ago
JSON representation
An AI powered, Notion-style WYSIWYG rich-text block-based editor. 🍀
- Host: GitHub
- URL: https://github.com/yiitap/yiitap
- Owner: yiitap
- License: mit
- Created: 2025-03-05T06:09:38.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-05-14T14:19:31.000Z (5 months ago)
- Last Synced: 2025-06-15T02:18:41.525Z (4 months ago)
- Topics: block, editor, notion, react, ts, typescript, vue, wysiwyg, wysiwyg-editor, yiitap
- Language: Vue
- Homepage: https://yiitap.pileax.ai
- Size: 5.94 MB
- Stars: 19
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Yiitap
Yiitap is an AI powered, Notion-style WYSIWYG rich-text block-based editor, built on top of [tiptap](https://tiptap.dev).🔥
## Features
🚀 **Supports Vue & React** – Seamless integration with both frameworks.
📝 **Modern Notion-style editor** – Clean, intuitive, and distraction-free.
🔧 **Highly customizable & extensible** – Built on **Tiptap** & **ProseMirror**.
🤖 **AI-powered** – Smart features to boost productivity.
🧩 **Block-based editing** – Manipulate content via **bubble, floating, main, or side menus**.
✨ **Rich feature set** – Includes **15+ custom extensions** & **50+ UI components**.
🌗 Light & Dark mode.
🆓 MIT Licensed.
## Quick start
- [Guide to Yiitap](https://yiitap.pileax.ai/guide/getting-started)
- [Live Demo](https://yiitap.pileax.ai/demo/vue)
- Full Example: [Live](https://yiitap.github.io/yiitap/) | [Source](https://github.com/yiitap/yiitap/blob/main/apps/vue/src/components/Demo.vue)
For more detailed information, make sure to check out our [documentation](https://yiitap.pileax.ai/guide/getting-started). If you encounter any problems or have suggestions, please open an issue.
## Screenshots
## Development
### Install dependencies
```shell
pnpm install
```
### Run demo
```shell
pnpm dev
```
### Build
```shell
pnpm build
```
## Others
### project structure
```shell
tree -d -L 3 -I "node_modules|dist|src|public|types" yiitap
```
```shell
yiitap
├── apps
│ ├── react # react demo app
│ └── vue # vue demo app
└── packages
├── core # core functions
├── extensions # extensions
│ ├── ai-block
│ ├── callout
│ ├── char-command
│ ├── code-block
│ ├── color-highlighter
│ ├── focus
│ ├── image
│ ├── link
│ ├── placeholder
│ ├── table
│ ├── table-wrapper
│ ├── trailing-node
│ ├── unique-id
│ └── video
├── icon # editor icon set
├── react # react component
├── utils # utilities
│ └── emoji
└── vue # vue component
```
## Thanks
- [Tiptap](https://github.com/ueberdosis/tiptap) & [ProseMirror](https://github.com/ProseMirror/prosemirror): Yiitap is built on top of Tiptap and ProseMirror.
- [BlockNote](https://github.com/TypeCellOS/BlockNote): A React Rich Text Editor that's block-based (Notion style) and extensible..
## License
The MIT License (MIT). Please see [License File](LICENSE) for more information.