还在为找不到一款既美观又强大的开源编辑器而烦恼吗?Novel编辑器绝对值得你一试!它基于Tiptap构建,拥有Notion风格的WYSIWYG编辑器界面,还集成了AI自动补全功能,支持本地化部署,让你的数据安全无忧。
极速上手:3分钟从零到一
想要快速体验Novel的魅力?只需三步即可完成部署:
git clone https://gitcode.com/gh_mirrors/no/novel
cd novel
pnpm install
pnpm dev
访问http://localhost:3000,你就能看到一个功能完整的Notion风格编辑器在本地运行。
极简配置方法
为了让AI功能正常使用,你只需在项目根目录创建.env.local文件,添加以下配置:
OPENAI_API_KEY=your_openai_api_key_here
BLOB_READ_WRITE_TOKEN=your_vercel_blob_token_here
第一个配置启用AI智能补全,第二个配置则让图片上传功能正常工作。如果没有AI需求,编辑器的基础功能完全不受影响!
✨ 核心亮点:为什么开发者都爱Novel
真正的所见即所得体验:Novel继承了Notion的优雅设计哲学,提供了流畅的编辑体验,所有内容块都支持实时预览和拖拽排序。
AI智能写作助手:编辑器内置了基于OpenAI的AI自动补全,可以帮助你续写文章、优化语句,快速生成代码示例和技术文档。
完全开源与可定制:Novel的代码完全透明,你可以深度定制编辑器的行为和样式,添加自己的扩展和插件。
本地化部署保障数据安全:所有数据都存储在你自己的服务器上,让你的数据安全无忧。
🔧 进阶玩法:打造专属编辑器
自定义扩展开发:Novel的模块化设计让你可以轻松添加新功能,如自定义Slash命令等。
样式深度定制:你可以通过修改相关文件来调整编辑器的外观。
集成现有系统:Novel可以作为独立组件集成到你的现有项目中。
⚠️ 避坑指南:常见问题快速解决
依赖安装失败:清除pnpm缓存、强制重新安装或检查Node.js版本。
AI功能无响应:检查OPENAI_API_KEY是否正确配置,或查看API调用逻辑。
图片上传失败:检查BLOB_READ_WRITE_TOKEN是否配置正确,或修改存储后端。
🌱 生态拓展:社区资源与学习路径
官方文档与示例:提供了快速开始指南、组件文档和扩展开发指南。
参与贡献:Novel是一个活跃的开源项目,欢迎开发者贡献代码。
✍️🚀 总结:开启高效写作新时代
Novel编辑器不仅仅是一个工具,它代表了一种全新的写作体验。通过将Notion的优雅设计、AI的智能辅助和开源的可定制性完美结合,它为技术写作者、内容创作者和开发者提供了一个理想的解决方案。
现在就开始你的Novel之旅吧!从克隆仓库到部署上线,整个过程不会超过30分钟。加入不断壮大的Novel社区,一起打造更好的开源编辑器生态。
记住:好的工具让创作更简单,而Novel让好的创作触手可及。
—— 苏承栈 | 极星编程网(www.jxgpc.com)
