An open-source Notion-style WYSIWYG editor with AI-powered autocompletions.
Introduction · Deploy Your Own · Setting Up Locally · Tech Stack · Contributing · License
https://novel.sh/docs/introduction
Novel is a Notion-style WYSIWYG editor with AI-powered autocompletions.
Novel.mp4
You can deploy your own version of Novel to Vercel with one click:
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)BLOB_READ_WRITE_TOKEN– your Vercel Blob read/write token (currently still in beta, but feel free to sign up on this form for access)
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
While Novel is built for React, we also have a few community-maintained packages for non-React frameworks:
- Svelte: https://novel.sh/svelte
- Vue: https://novel.sh/vue
Thanks to @bennykok, Novel also has a VSCode Extension: https://novel.sh/vscode
CleanShot.2023-09-02.at.09.36.03.mp4
Novel is built on the following stack:
- Next.js – framework
- Tiptap – text editor
- OpenAI - AI completions
- Vercel AI SDK – AI library
- Vercel – deployments
- TailwindCSS – styles
- Cal Sans – font
Here's how you can contribute:
- Open an issue if you believe you've encountered a bug.
- Make a pull request to add new features/make quality-of-life improvements/fix bugs.
Licensed under the Apache-2.0 license.