/novel

Notion-style WYSIWYG editor with AI-powered autocompletion.

Primary LanguageTypeScriptApache License 2.0Apache-2.0

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

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.

Novel.mp4

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:

  • 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:

VSCode Extension

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

CleanShot.2023-09-02.at.09.36.03.mp4

Tech Stack

Novel is built on the following stack:

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.