Repository files navigation

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.

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 onehere)
• BLOB_READ_WRITE_TOKEN – your Vercel Blob read/write token (currentlystill in beta, but feel free tosign up on this form for access)

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

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

pnpm ipnpm 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

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 apull request to add new features/make quality-of-life improvements/fix bugs.

Licensed under theApache-2.0 license.