sergeysova / craft Goto Github PK

An open-source Notion-style WYSIWYG editor with AI extensions support.

Introduction · Installation · Setting Up Locally · Tech Stack · Contributing · Fork · Roadmap · License

Craft Editor is a Notion-style WYSIWYG editor with AI extensions support.

To use Craft Editor in a project, you can run the following command to install the @sergeysova/craft NPM package:

npm add @sergeysova/craft

Then, you can use it in your code like this:

import { useState } from "react";
import { CraftEditor, JSONContent } from "@sergeysova/craft";

export default function App() {
  const [content, setContent] = useState<JSONContent>({})

  return <CraftEditor content={content} onUpdate={(editor) => setContent(editor.getJSON())} />;
}

To set up CraftEditor locally, you'll need to clone the repository.

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 build
pnpm dev

CraftEditor is built on the following stack:

• Tiptap – extendable text editor
• Prosemirror – text editing framework under Tiptap
• TailwindCSS – styles
• Cal Sans – font
• Next.js – framework for web app example
• Vercel – deployments

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.

This project is an enhanced version of Novel, originally created by Steven Tey. I am forked it to introduce additional customization options, all without the constraints of maintaining backward compatibility of Novel.

I am created @sergeysova/craft with the aim of offering a more modular and customizable editor experience. My changes include updating dependencies, streamlining the default editor content, and disabling certain features like the Image block and AI support. These features are not gone for good; rather, I am planning to reintroduce them as optional extensions, giving you the freedom to tailor the editor to your needs.

• Documentation: To provide detailed guides and tutorials for extending functionalities, integrating with state managers, and utilizing AI capabilities.
• Craft Editor Control: To seamlessly integrate with any state manager.
• Modular AI Features: Move AI capabilities to an extension for optional use.
• Image Uploading as an Extension: To give you the choice to include it or not.
• Command Popup Customization: Allowing the installation of various block types.
• Independence from Vercel: Making CraftEditor fully self-reliant for uploading, AI, analytics, and more.
• Notion-like Menu: For each line, features for transforming, settings, deletion, etc., will be available.
• i18n Support: To enable internationalization and localization for a more accessible and global user experience.

By making these changes, we aim to provide a more flexible and user-friendly editor that can be easily integrated into your existing tech stack.

Licensed under the Apache-2.0 license.