Novel is an open-source, Notion-style WYSIWYG editor designed for developers seeking a customizable and AI-enhanced writing experience. It provides a rich text editing interface with AI-powered autocompletion, aiming to streamline content creation.

How It Works

Novel leverages a modern web technology stack, including Next.js for the framework, Tiptap for the core WYSIWYG editor functionality, and the Vercel AI SDK for integrating AI completions. OpenAI's API powers the autocompletion feature, offering intelligent suggestions as users type. Styling is handled by TailwindCSS, and deployments are facilitated by Vercel.

Quick Start & Requirements

• Install dependencies and run locally: pnpm i followed by pnpm dev.
• Requires an OpenAI API key and a Vercel Blob read/write token (currently in beta).
• Community-maintained packages are available for Svelte and Vue.
• A VSCode Extension is also available.

Highlighted Details

• Notion-style user interface.
• AI-powered autocompletion via OpenAI.
• Built with Next.js, Tiptap, and Vercel AI SDK.
• Cross-framework support via community packages (Svelte, Vue).
• VSCode Extension available.

Maintenance & Community

The project is actively maintained by Steven Tey, with contributions encouraged through issues and pull requests. Further community engagement details are not explicitly provided in the README.

Licensing & Compatibility

Licensed under the Apache-2.0 license, permitting commercial use and integration into closed-source projects.

Limitations & Caveats

Vercel Blob token is currently in beta, which may affect full functionality for new users. Documentation is marked as "Work In Progress" (WIP).