Novel

Novel: AI-Powered WYSIWYG Editor for Modern Writing

Novel is an open-source, Notion-style WYSIWYG editor designed to enhance your writing experience with AI-powered autocompletion. Built using Tiptap and the Vercel AI SDK, Novel provides a seamless and intuitive interface for creating content.

What is Novel?

Novel is a modern editor that combines the simplicity of a WYSIWYG interface with the power of AI. It's designed to help you write more efficiently and effectively. Whether you're drafting blog posts, documentation, or any other type of content, Novel offers a range of features to streamline your workflow.

How does Novel work?

Novel leverages the Tiptap framework for its core editing capabilities, providing a robust and customizable foundation. The Vercel AI SDK is integrated to provide intelligent autocompletion suggestions as you type, helping you to complete sentences and generate ideas more quickly.

Key Features:

• Slash Menu & Bubble Menu: Access a wide range of formatting options and features through intuitive menus.
• AI Autocomplete: Activate AI-powered suggestions by typing ++ or selecting from the slash menu.
• Image Uploads: Easily add images to your content with drag-and-drop, copy-and-paste, or by selecting from the slash menu.
• Tweet Embedding: Embed tweets directly into your content using the slash menu.
• LaTeX Support: Add mathematical symbols and equations using LaTeX expressions.

How to use Novel?

1. Installation: Install Novel using npm:

   npm i novel
   

2. Usage: Import the Editor component into your React application:

   import { Editor } from "novel";
   
   export default function App() {
     return (
        <Editor />
     )
   }
   

Why choose Novel?

• Enhanced Productivity: AI-powered autocompletion helps you write faster and more efficiently.
• Seamless Integration: Built with Tiptap and Vercel AI SDK for a robust and customizable editing experience.
• Versatile Features: Supports image uploads, tweet embedding, and LaTeX expressions.
• Open Source: Freely use, modify, and contribute to the project.

Who is Novel for?

Novel is ideal for:

• Content Creators: Bloggers, writers, and marketers who need a powerful and easy-to-use editor.
• Developers: Those who want to integrate a customizable editor into their applications.
• Students and Academics: Anyone who needs to write documents with mathematical symbols and equations.

Best way to get started with Novel?

1. Install the package: Begin by installing the Novel package using npm.
2. Integrate the editor: Import the Editor component into your React application and start writing.
3. Explore the features: Experiment with the slash menu, AI autocompletion, and other features to enhance your writing experience.

Novel is a powerful and versatile editor that can help you write more efficiently and effectively. Its AI-powered features and intuitive interface make it a great choice for anyone who wants to create high-quality content.