novel README

The project's README from github.com/steven-tey/novel. As one markdown file: README.md.

Novel is a Notion-style WYSIWYG editor with AI-powered autocompletions.

Novel

An open-source Notion-style WYSIWYG editor with AI-powered autocompletions.

Hacker News License Novel.sh's GitHub repo

Introduction · Deploy Your Own · Setting Up Locally · Tech Stack · Contributing · License


Docs (WIP)

https://novel.sh/docs/introduction

Introduction

Novel is a Notion-style WYSIWYG editor with AI-powered autocompletions.

https://github.com/steven-tey/novel/assets/28986134/2099877f-4f2b-4b1c-8782-5d803d63be5c


Deploy Your Own

You can deploy your own version of Novel to Vercel with one click:

Deploy with Vercel

Setting Up Locally

To set up Novel locally, you'll need to clone the repository and set up the following environment variables:

If you've deployed this to Vercel, you can also use vc env pull to pull the environment variables from your Vercel project.

To run the app locally, you can run the following commands:

pnpm i
pnpm dev

Cross-framework support

While Novel is built for React, we also have a few community-maintained packages for non-React frameworks:

VSCode Extension

Thanks to @bennykok, Novel also has a VSCode Extension: https://novel.sh/vscode

https://github.com/steven-tey/novel/assets/28986134/58ebf7e3-cdb3-43df-878b-119e304f7373

Tech Stack

Novel is built on the following stack:

Contributing

Here's how you can contribute:

Repo Activity

Novel.sh repo activity – generated by Axiom

License

Licensed under the Apache-2.0 license.

novel (steven-tey/novel)

Searching Database…

16.4K ·GitHub
这是什么?Novel 是一个开源的、Notion 风格的所见即所得编辑器,带有 AI 自动补全功能——它的界面看起来像 Notion,还能用 AI 帮你把句子写完。
这是需要注册使用的托管服务,还是我自己部署运行的?是你自己部署运行的:它是一个开源的 Web 应用,你可以一键部署到自己的 Vercel 账号,开发时也可以在本地运行。
我在本地怎么把它跑起来?克隆仓库,设置两个环境变量——OPENAI_API_KEY 和 BLOB_READ_WRITE_TOKEN——然后启动开发服务器。已经部署到 Vercel 了吗?vc env pull 会把你项目里的变量拉取下来。
这需要我自己准备 API 密钥吗?需要:AI 补全功能要靠你自己的 OpenAI API 密钥,另外还需要一个 Vercel Blob 读写令牌,它目前还在测试阶段,需要填写表单申请才能获得访问权限。
有没有还不够完善的地方?有两点:Vercel Blob 存储集成目前还在测试阶段,文档也标注为仍在编写中。
它能连接我的 Notion 工作区吗?不能——'Notion 风格'只是形容这个编辑器的外观和使用感受。README 里没有提到任何 Notion 集成,它是一个由你自己部署的独立编辑器。
有 VSCode 扩展吗?有——社区维护者 bennykok 开发了一个 VSCode 扩展,把 Novel 风格的编辑体验带到了 VS Code 中,它与网页版应用是相互独立的。
Creator
steven-tey
Size
90.5 MB
Stars
16.4K
Age
3y
Commits · 90 Days