Novel简介
Novel是一个开源的Notion风格所见即所得(WYSIWYG)编辑器,具有AI驱动的自动补全功能。它提供了类似Notion的编辑体验,并集成了OpenAI的AI能力,可以智能地补全文本内容。
核心特性
- Notion风格的所见即所得编辑器
- AI驱动的智能文本自动补全
- 跨框架支持(React, Svelte, Vue等)
- 开源且可自由定制
快速部署
你可以通过以下方式一键将Novel部署到Vercel:
本地设置
-
克隆Novel仓库
-
设置环境变量:
OPENAI_API_KEY
: OpenAI API密钥BLOB_READ_WRITE_TOKEN
: Vercel Blob读写令牌
-
安装依赖并运行:
pnpm i
pnpm dev
技术栈
Novel基于以下技术栈构建:
- Next.js - 框架
- Tiptap - 文本编辑器
- OpenAI - AI补全
- Vercel AI SDK - AI库
- Vercel - 部署
- TailwindCSS - 样式
- Cal Sans - 字体
扩展支持
除了React版本,Novel还提供了其他框架的社区维护版本:
- Svelte: https://novel.sh/svelte
- Vue: https://novel.sh/vue
还有VSCode插件版本: https://novel.sh/vscode
贡献指南
欢迎为Novel做出贡献:
- 提交issue报告bug
- 提交pull request添加新功能或修复问题
Novel是一个强大而灵活的编辑器工具,欢迎开发者们探索使用,为其贡献新的想法和代码!