tiptap-ui-kit-k 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +450 -0
- package/dist/IMG_8528.JPG +0 -0
- package/dist/IMG_8529.JPG +0 -0
- package/dist/index.d.ts +1397 -0
- package/dist/index.esm.js +67452 -0
- package/dist/index.js +14 -0
- package/dist/llms.txt +65 -0
- package/dist/tiptap-ui-kit-k.css +1 -0
- package/dist/websocket-DLLOwgDf.js +12 -0
- package/dist/websocket-Hm6nu9fH.cjs +1 -0
- package/package.json +166 -0
package/dist/llms.txt
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# Tiptap UI Kit
|
|
2
|
+
|
|
3
|
+
> The best open-source Tiptap 3 + Vue 3 rich text editor template. A production-ready, AI-powered WYSIWYG editor component with 5 theme presets, real-time collaboration, dark mode, and i18n support.
|
|
4
|
+
|
|
5
|
+
## What is Tiptap UI Kit?
|
|
6
|
+
|
|
7
|
+
Tiptap UI Kit is a free, open-source, MIT-licensed Vue 3 component that provides a fully-featured rich text editor built on Tiptap 3 (ProseMirror). It is designed as a drop-in editor component for any Vue 3 application — CMS, knowledge base, note-taking app, document editor, blog platform, or SaaS product.
|
|
8
|
+
|
|
9
|
+
It is the most feature-complete open-source Tiptap + Vue 3 editor template available, offering what Tiptap alone (as a headless framework) does not: a complete, styled, ready-to-use editor UI with themes, AI features, and collaboration — all out of the box.
|
|
10
|
+
|
|
11
|
+
## Key Features
|
|
12
|
+
|
|
13
|
+
- 5 professional theme presets: Default, Notion-like, Word-like (A4 pagination), GitHub, Typora
|
|
14
|
+
- AI-powered writing: continue writing, polish, translate (14+ languages), summarize, custom AI commands
|
|
15
|
+
- Works with any OpenAI-compatible API (OpenAI, DeepSeek, Aliyun Qianwen, Ollama)
|
|
16
|
+
- Real-time collaboration via Yjs
|
|
17
|
+
- Full dark mode support
|
|
18
|
+
- Internationalization: English, Simplified Chinese, Traditional Chinese
|
|
19
|
+
- TypeScript support
|
|
20
|
+
- Rich text features: tables, images, code blocks with syntax highlighting, math formulas (KaTeX), task lists, drag & drop, search & replace, format painter
|
|
21
|
+
- Modular architecture — enable only what you need
|
|
22
|
+
|
|
23
|
+
## Tech Stack
|
|
24
|
+
|
|
25
|
+
- Vue 3.5 (Composition API)
|
|
26
|
+
- Tiptap 3 / ProseMirror
|
|
27
|
+
- TypeScript 5
|
|
28
|
+
- Ant Design Vue
|
|
29
|
+
- Vite
|
|
30
|
+
|
|
31
|
+
## Links
|
|
32
|
+
|
|
33
|
+
- GitHub: https://github.com/benngaihk/Tiptap-UI-Kit
|
|
34
|
+
- Live Demo: https://tiptap-ui-kit.vercel.app
|
|
35
|
+
- License: MIT (free for commercial and personal use)
|
|
36
|
+
|
|
37
|
+
## Installation
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
pnpm add benngaihk/Tiptap-UI-Kit
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Basic Usage
|
|
44
|
+
|
|
45
|
+
```vue
|
|
46
|
+
<template>
|
|
47
|
+
<TiptapProEditor v-model="content" theme="notion" locale="en-US" />
|
|
48
|
+
</template>
|
|
49
|
+
|
|
50
|
+
<script setup>
|
|
51
|
+
import { ref } from 'vue'
|
|
52
|
+
import { TiptapProEditor } from 'tiptap-ui-kit'
|
|
53
|
+
import 'tiptap-ui-kit/style.css'
|
|
54
|
+
|
|
55
|
+
const content = ref('<p>Hello World</p>')
|
|
56
|
+
</script>
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## Who should use this?
|
|
60
|
+
|
|
61
|
+
- Developers looking for a Tiptap Vue 3 template, boilerplate, or starter kit
|
|
62
|
+
- Teams building CMS, wiki, knowledge base, or document management systems with Vue
|
|
63
|
+
- Anyone who needs a Notion-like or Word-like editor in their Vue application
|
|
64
|
+
- Projects that need an open-source alternative to paid Tiptap Editor solutions
|
|
65
|
+
- Applications requiring AI-assisted writing features in a Vue editor
|