@myth-dev/echo-editor (0.4.8)
Published 2026-09-14 14:33:20 +08:00 by zuchaoli
Installation
@myth-dev:registry=npm install @myth-dev/echo-editor@0.4.8"@myth-dev/echo-editor": "0.4.8"About this package
Echo Editor
一款基于 tiptap 和 shadcn-vue 的新一代 AI 富文本编辑器。
English | 中文
在线演示
特性
- 🎨 使用 shadcn-vue 精美组件
- ✨ AI 智能写作辅助
- 📝 支持 Markdown 及实时预览
- 🔤 丰富的文本格式化功能(标题、列表、引用等)
- 📊 表格和代码块支持
- 🎯 自定义字体大小和样式
- 📄 支持导入 Word 文档
- 🌍 国际化支持(
en、zhHans) - 🧩 可扩展架构 - 支持自定义扩展
- 🎭 TypeScript 支持
- 🎨 Tailwind CSS 支持
安装
npm install echo-editor
# 或
pnpm install echo-editor
# 或
yarn add echo-editor
使用方法
方式一:全局注册
// main.ts
import { createApp } from 'vue'
import App from './App.vue'
import EchoEditor from 'echo-editor'
import 'echo-editor/style.css'
const app = createApp(App)
app.use(EchoEditor)
app.mount('#app')
<script setup>
import { BaseKit } from 'echo-editor'
const content = ref('')
const extensions = [
BaseKit.configure({
placeholder: {
placeholder: '开始写作...',
},
}),
]
</script>
<template>
<echo-editor :extensions="extensions" v-model="content" />
</template>
方式二:直接使用
<script setup>
import { EchoEditor, BaseKit } from 'echo-editor'
import 'echo-editor/style.css'
const content = ref('')
const extensions = [
BaseKit.configure({
placeholder: {
placeholder: '开始写作...',
},
}),
]
</script>
<template>
<echo-editor :extensions="extensions" v-model="content" />
</template>
开发
- 安装 pnpm
- 克隆仓库
- 运行
pnpm install - 使用
pnpm dev启动开发服务器
测试构建版本:
pnpm examples
贡献
欢迎提交 Pull Request 来帮助改进项目!
相关项目
许可证
Dependencies
Dependencies
| ID | Version |
|---|---|
| @tiptap/core | ^2.11.5 |
| @tiptap/extension-blockquote | ^2.11.5 |
| @tiptap/extension-bold | ^2.11.5 |
| @tiptap/extension-bubble-menu | ^2.11.5 |
| @tiptap/extension-bullet-list | ^2.11.5 |
| @tiptap/extension-character-count | ^2.11.5 |
| @tiptap/extension-code | ^2.11.5 |
| @tiptap/extension-collaboration | ^2.27.2 |
| @tiptap/extension-collaboration-cursor | ^2.26.2 |
| @tiptap/extension-color | ^2.11.5 |
| @tiptap/extension-document | ^2.11.5 |
| @tiptap/extension-dropcursor | ^2.11.5 |
| @tiptap/extension-focus | ^2.11.5 |
| @tiptap/extension-font-family | ^2.11.5 |
| @tiptap/extension-gapcursor | ^2.11.5 |
| @tiptap/extension-hard-break | ^2.11.5 |
| @tiptap/extension-heading | ^2.11.5 |
| @tiptap/extension-highlight | ^2.11.5 |
| @tiptap/extension-history | ^2.11.5 |
| @tiptap/extension-horizontal-rule | ^2.11.5 |
| @tiptap/extension-image | ^2.11.5 |
| @tiptap/extension-italic | ^2.11.5 |
| @tiptap/extension-link | ^2.11.5 |
| @tiptap/extension-list-item | ^2.11.5 |
| @tiptap/extension-ordered-list | ^2.11.5 |
| @tiptap/extension-paragraph | ^2.11.5 |
| @tiptap/extension-placeholder | ^2.11.5 |
| @tiptap/extension-strike | ^2.11.5 |
| @tiptap/extension-subscript | ^2.11.5 |
| @tiptap/extension-superscript | ^2.11.5 |
| @tiptap/extension-table | ^2.11.5 |
| @tiptap/extension-table-cell | ^2.11.5 |
| @tiptap/extension-table-header | ^2.11.5 |
| @tiptap/extension-table-row | ^2.11.5 |
| @tiptap/extension-task-item | ^2.11.5 |
| @tiptap/extension-task-list | ^2.11.5 |
| @tiptap/extension-text | ^2.11.5 |
| @tiptap/extension-text-align | ^2.11.5 |
| @tiptap/extension-text-style | ^2.11.5 |
| @tiptap/extension-underline | ^2.11.5 |
| @tiptap/pm | ^2.11.5 |
| @tiptap/suggestion | ^2.11.5 |
| @tiptap/vue-3 | ^2.11.5 |
| @vueuse/core | ^10.11.1 |
| class-variance-authority | ^0.7.1 |
| clsx | ^2.1.1 |
| hotkeys-js | ^3.13.7 |
| lucide-vue-next | ^0.477.0 |
| reka-ui | ^2.0.2 |
| tippy.js | ^6.3.7 |
| y-prosemirror | ^1.2.1 |
| yjs | ^13.6.23 |
Development Dependencies
| ID | Version |
|---|---|
| @commitlint/cli | ^19.3.0 |
| @commitlint/config-conventional | ^19.2.2 |
| @commitlint/cz-commitlint | ^19.2.0 |
| @types/node | ^24.0.14 |
| @typescript-eslint/eslint-plugin | ^7.9.0 |
| @typescript-eslint/parser | ^7.9.0 |
| @vitejs/plugin-vue | ^6.0.0 |
| @vue/tsconfig | ^0.7.0 |
| autoprefixer | ^10.4.19 |
| code-inspector-plugin | ^0.16.1 |
| commitizen | ^4.3.0 |
| commitlint | ^19.3.0 |
| eslint | ^8.12.0 |
| eslint-config-prettier | ^9.1.0 |
| eslint-plugin-import | ^2.29.1 |
| eslint-plugin-prettier | ^5.1.3 |
| eslint-plugin-vue | ^9.26.0 |
| husky | ^9.0.11 |
| lint-staged | ^15.2.2 |
| lodash | ^4.17.21 |
| lodash-unified | ^1.0.3 |
| postcss | ^8.5.6 |
| postcss-prefix-selector | ^2.1.1 |
| prettier | ^3.2.5 |
| prism-code-editor | ^4.0.0 |
| prosemirror-model | ^1.25.10 |
| tailwind-merge | ^2.6.0 |
| tailwindcss | ^3.4.3 |
| tailwindcss-animate | ^1.0.7 |
| typescript | ~5.8.3 |
| vite | ^7.0.4 |
| vite-plugin-dts | ^3.9.0 |
| vue | ^3.5.17 |
| vue-tsc | ^2.2.12 |
| y-websocket | ^2.1.0 |
Peer Dependencies
| ID | Version |
|---|---|
| vue | >= 3.0.0 |
Keywords
echo editor
WYSIWYG
vue
vue.js
typescript
tiptap
editor
shadcn ui
wysiwyg
rich text
markdown
Details
Assets (1)
Versions (7)
View all
echo-editor-0.4.8.tgz
489 KiB
