3分钟上手 Novel：从下载到启动的超简单教程
项目地址: https://gitcode.com/gh_mirrors/no/novel 你是否还在为寻找一款既美观又智能的编辑器而烦恼？ Novel 作为一款 Notion 风格的所见即所得（WYSIWYG）编辑器，不仅拥有优雅的界面设计，还集成了 AI 自动补全功能，让你的写作效率提升 300%！本文将带你一步步完成 Novel 项目的下载与安装，无需复杂操作，3 分钟即可开启高效编辑之旅。读完本文，你将掌握：Novel 项目的克隆方法、环境变量配置技巧、本地启动步骤以及常见问题解决办法。
项目简介
Novel 是一款开源的 Notion 风格编辑器，它的核心特点是所见即所得的编辑体验和 AI 驱动的自动补全功能。无论是撰写文档、编辑博客还是整理笔记，Novel 都能满足你的需求。项目基于 Next.js 框架构建，结合了 Tiptap 文本编辑器、OpenAI 人工智能、Vercel AI SDK 等先进技术，为用户提供流畅、智能的编辑环境。
官方文档：apps/docs/introduction.mdx
准备工作
在开始安装 Novel 之前，请确保你的电脑已安装以下软件：
- Git：用于克隆项目仓库
- Node.js：建议版本 16.x 及以上
- pnpm：包管理工具
如果你还未安装这些软件，可以参考官方文档或相关教程进行安装。
下载项目
克隆仓库
打开终端，执行以下命令克隆 Novel 项目仓库：
git clone https://gitcode.com/gh_mirrors/no/novel.git
该命令会将项目代码下载到当前目录下的 novel 文件夹中。
进入项目目录
克隆完成后，使用以下命令进入项目目录：
cd novel
安装依赖
Novel 项目使用 pnpm 作为包管理工具，执行以下命令安装项目依赖：
pnpm i
这一步会根据项目根目录下的 package.json 文件安装所需的所有依赖包，可能需要几分钟时间，请耐心等待。
配置环境变量
Novel 项目需要一些环境变量才能正常运行，主要包括：
OPENAI_API_KEY：你的 OpenAI API 密钥，用于 AI 自动补全功能BLOB_READ_WRITE_TOKEN：Vercel Blob 的读写令牌，用于文件上传功能
创建环境变量文件
在项目根目录下创建 .env.local 文件，并添加以下内容：
OPENAI_API_KEY=你的OpenAI API密钥
BLOB_READ_WRITE_TOKEN=你的Vercel Blob令牌
如果你没有这些密钥，可以参考官方文档 apps/docs/quickstart.mdx 获取申请方法。
启动项目
一切准备就绪后，执行以下命令启动本地开发服务器：
pnpm dev
启动成功后，你会看到类似以下的输出：
ready - started server on 0.0.0.0:3000, url: http://localhost:3000
info - Loaded env from .env.local
此时，打开浏览器访问 http://localhost:3000，即可看到 Novel 编辑器的主界面。
界面预览
Novel 编辑器提供了简洁美观的界面，支持明暗两种主题模式。
明亮主题
暗黑主题
编辑器的气泡菜单也有两种主题可供选择：
气泡菜单 - 明亮主题
气泡菜单 - 暗黑主题
常见问题解决
依赖安装失败
如果执行 pnpm i 时出现依赖安装失败的情况，可以尝试以下解决方法：
- 确保 pnpm 版本是最新的：
pnpm install -g pnpm - 清除 pnpm 缓存：
pnpm store prune - 重新安装依赖：
pnpm i
启动时报错
如果启动项目时出现错误，首先检查环境变量是否配置正确。如果是其他错误，可以查看终端输出的错误信息，或参考项目的 SECURITY.md 文件寻求帮助。
总结
通过本文的教程，你已经成功完成了 Novel 项目的下载、安装和启动。现在，你可以开始探索这款强大的编辑器了。无论是日常写作、项目文档编写还是内容创作，Novel 都能成为你的得力助手。如果你想深入了解 Novel 的更多功能，可以查阅官方开发文档 apps/docs/development.mdx。
希望本教程对你有所帮助，祝你使用愉快！
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
