steven-tey /novel
Notion-style WYSIWYG editor with AI-powered autocompletion.
★ 16,466⑂ 1,374👁 53⑃ 161● 269▤ 29
+0
日增长
16,466
stars
1,374
forks
53
watchers
161
prs
269
issues
29
releases
README
Novel
An open-source Notion-style WYSIWYG editor with AI-powered autocompletions.
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:
Setting Up Locally
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
Cross-framework support
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
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:
- Next.js – framework
- Tiptap – text editor
- OpenAI - AI completions
- Vercel AI SDK – AI library
- Vercel – deployments
- TailwindCSS – styles
- Cal Sans – font
Contributing
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.
Repo Activity
!Novel.sh repo activity – generated by Axiom
License
Licensed under the Apache-2.0 license.Top issues
#327bug: Module '"novel"' declares 'Editor' locally, but it is not exported.14 comments · 2024-03-05#405feat: Allow Markdown and Html in InitialContent12 comments · 2024-05-31#357bug: Cannot find module 'novel/extensions' or its corresponding type declarations.11 comments · 2024-03-22#508Dead library8 comments · 2025-08-17#355RangeError: Schema is missing its top node type ('doc')8 comments · 2024-03-22#418Global CSS cannot be imported from within node_modules.bug: 7 comments · 2024-06-28#378TypeError: undefined is not iterable (cannot read property Symbol(Symbol.iterator))bug: 6 comments · 2024-04-11#70Add support for different API routes for additional slash commands6 comments · 2023-07-05
Discussions
#519novel is listed on Shypd — AI Tool Directory0 comments · 2026-03-30#511Why limit AI completions to OpenAI?0 comments · 2025-11-17#509it work0 comments · 2025-09-04#500Tiptap v3 update in the roadmap? How do I ssr editor content1 comments · 2025-05-10#499Start time on youtube0 comments · 2025-05-04#496Creating a AI-less version0 comments · 2025-04-14#488Add rtl, ltr and center0 comments · 2025-02-19#482Could this be used to edit markdown and save it back as markdown?1 comments · 2025-01-26
Latest release
[email protected] [email protected] 2025-02-11Full Changelog: https://github.com/steven-tey/novel/compare/[email protected]@1.0.1 Full Changelog: https://github.com/steven-tey/novel/compare/[email protected]@1.0.2