steven-tey/novel

项目概览

该项目在一个开源的软件包中，将类似 Notion 的界面与基于 OpenAI 的文本自动补全结合在一起。

项目类型

基础设施

应用场景

文档办公

部署方式

查看项目说明

License

Apache-2.0

适合谁

• 寻找带有内置 AI 自动补全功能且类 Notion 风格的开源所见即所得编辑器的开发者。

核心能力

• 提供类似 Notion 风格的富文本编辑体验，支持用户直接在界面上进行所见即所得的内容创作与排版。
• 利用 OpenAI 在编辑器内部直接提供由 AI 驱动的文本自动补全功能。该功能的运行需要配置 OpenAI API，并且依赖 Vercel Blob 外部服务。

限制与风险

• 该项目主要为 React 框架构建，非 React 框架的集成需依赖社区提供的第三方包。
• 在撰写相关资料时，该项目依赖的 Vercel Blob 存储组件尚处于 Beta 阶段。

如何开始

• 上手难度属于中等。需要准备 pnpm 和 Node 环境，并注册获取 OpenAI 和 Vercel Blob 的外部 API 密钥。成功运行的第一步路径为：克隆仓库，配置 OPENAI_API_KEY 和 BLOB_READ_WRITE_TOKEN 环境变量，运行 pnpm i，然后运行 pnpm dev。

核验依据

• GitHub 项目简介: Notion-style WYSIWYG editor with AI-powered autocompletion.
• README: [Novel](https://novel.sh/) is a Notion-style WYSIWYG editor with AI-powered autocompletions.
• README: An open-source Notion-style WYSIWYG editor with AI-powered autocompletions.
• README: To set up Novel locally, you'll need to clone the repository and set up the following environment variables: - `OPENAI_API_KEY` – your OpenAI API key (you can get one [here](https…
• README: - [OpenAI](https://openai.com/) - AI completions - [Vercel AI SDK](https://sdk.vercel.ai/docs) – AI library

内容核验时间：