explaingit

steven-tey/novel

Analysis updated 2026-06-24

16,261TypeScriptAudience · developerComplexity · 3/5LicenseSetup · moderate

TLDR

Novel is an open-source Notion-style WYSIWYG editor with AI-powered autocomplete. Deploy your own with one-click on Vercel and an OpenAI API key.

Mindmap

mindmap
  root((novel))
    Inputs
      User text
      OpenAI key
    Outputs
      Formatted documents
      AI completions
    Use Cases
      Embed in SaaS app
      Self host editor
      Build writing tool
    Tech Stack
      Next.js
      TypeScript
      Tiptap
      OpenAI
      Vercel
    Ports
      Svelte
      Vue
      VSCode extension
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Deploy your own Notion-style editor with AI autocomplete on Vercel

USE CASE 2

Embed the Novel editor into a Next.js SaaS app for writing or notes

USE CASE 3

Use the Svelte or Vue port of Novel inside a non-React stack

USE CASE 4

Fork Novel as a starting point for a custom AI-assisted writing tool

What is it built with?

Next.jsTypeScriptTiptapOpenAIVercel

How does it compare?

steven-tey/noveludecode/platetypescript-eslint/typescript-eslint
Stars16,26116,25616,244
LanguageTypeScriptTypeScriptTypeScript
Setup difficultymoderatemoderateeasy
Complexity3/53/53/5
Audiencedeveloperdeveloperdeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · moderate Time to first run · 30min

Needs an OpenAI API key for the AI autocomplete features to work.

Apache-2.0: use, modify, and distribute freely including for commercial projects, with a patent grant and a requirement to keep the notice.

In plain English

Novel is an open-source text editor that works and feels like Notion, a popular writing and note-taking app, but with the added ability to autocomplete your writing using AI. As you type, you can trigger AI suggestions that continue your sentences or paragraphs for you, making it useful for anyone who wants a smart writing assistant built directly into their editor. The editor is a WYSIWYG tool, which stands for "What You See Is What You Get", meaning the text looks as it will appear when published, with formatting like bold, headings, and bullet points visible as you write rather than shown as code. You can deploy your own private version of this editor to the web with a single click using Vercel, a hosting platform. To run it yourself, you'll need an OpenAI API key (which powers the AI autocomplete feature). The project is built using Next.js (a popular web app framework), Tiptap (a rich text editor library), OpenAI for AI completions, and Vercel for hosting. It is primarily written in TypeScript and also has community-maintained versions for non-React frameworks including Svelte and Vue, plus a VSCode extension for use inside a code editor. The project is open-source under the Apache-2.0 license, meaning anyone can use or modify it freely.

Copy-paste prompts

Prompt 1
Walk me through forking Novel and deploying it to Vercel with my own OpenAI API key
Prompt 2
Embed the Novel editor inside an existing Next.js app and persist content to my Postgres database
Prompt 3
Customize Novel's AI autocomplete prompt to match my product's tone of voice
Prompt 4
Add a custom Tiptap extension to Novel that inserts a callout block from a slash command

Frequently asked questions

What is novel?

Novel is an open-source Notion-style WYSIWYG editor with AI-powered autocomplete. Deploy your own with one-click on Vercel and an OpenAI API key.

What language is novel written in?

Mainly TypeScript. The stack also includes Next.js, TypeScript, Tiptap.

What license does novel use?

Apache-2.0: use, modify, and distribute freely including for commercial projects, with a patent grant and a requirement to keep the notice.

How hard is novel to set up?

Setup difficulty is rated moderate, with roughly 30min to a first successful run.

Who is novel for?

Mainly developer.

Open on GitHub → Explain another repo

This repo across BitVibe Labs

Scan in gitsafehub Deploy in gitdeployhub steven-tey on gitmyhub

Verify against the repo before relying on details.