Awesome
<a href="https://novel.sh"> <img alt="Novel is a Notion-style WYSIWYG editor with AI-powered autocompletions." src="https://novel.sh/opengraph-image.png"> <h1 align="center">Novel</h1> </a> <p align="center"> An open-source Notion-style WYSIWYG editor with AI-powered autocompletions. </p> <p align="center"> <a href="https://news.ycombinator.com/item?id=36360789"><img src="https://img.shields.io/badge/Hacker%20News-369-%23FF6600" alt="Hacker News"></a> <a href="https://github.com/steven-tey/novel/blob/main/LICENSE"> <img src="https://img.shields.io/github/license/steven-tey/novel?label=license&logo=github&color=f80&logoColor=fff" alt="License" /> </a> <a href="https://github.com/steven-tey/novel"><img src="https://img.shields.io/github/stars/steven-tey/novel?style=social" alt="Novel.sh's GitHub repo"></a> </p> <p align="center"> <a href="#introduction"><strong>Introduction</strong></a> · <a href="#deploy-your-own"><strong>Deploy Your Own</strong></a> · <a href="#setting-up-locally"><strong>Setting Up Locally</strong></a> · <a href="#tech-stack"><strong>Tech Stack</strong></a> · <a href="#contributing"><strong>Contributing</strong></a> · <a href="#license"><strong>License</strong></a> </p> <br/>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
<br />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
License
Licensed under the Apache-2.0 license.