Skip to content

CafeinoDev/tiptap-notion

Repository files navigation

📝 Tiptap Notion-Like Editor

✨ Features:

  • 📄 Rich text editing with Notion-style blocks.
  • 🤝 Real-time collaboration using Y.js.
  • 🛠️ Extensible architecture powered by Tiptap.
  • 🌟 Minimalistic and user-friendly design.
  • 📦 Easy integration into any web app.

A Notion-inspired editor built with Tiptap and Y.js to deliver a seamless and collaborative writing experience.

✨ Features

  • 📄 Rich Text Editing: Supports Notion-style blocks like headings, lists, and code blocks.
  • 🤝 Real-Time Collaboration: Powered by Y.js for seamless collaborative editing.
  • 🛠️ Extensible Architecture: Add custom Tiptap extensions to suit your needs.
  • 🌟 User-Friendly Design: Minimalistic and distraction-free interface.
  • 📦 Easy Integration: Ready to drop into your web app.

📚 Installation

  1. Clone the repository:

    git clone https://github.com/CafeinoDev/tiptap-notion.git
    cd tiptap-notion
  2. Install dependencies:

    # npm
    npm install
    # or bun
    bun install
  3. Start the development server:

    # npm
    npm run dev
    # or bun
    bun dev

🤝 Collaboration Setup

This editor uses Y.js for collaboration. To enable real-time updates:

  1. Set up a WebSocket server with y-websocket.
  2. Configure the Collaboration extension in the editor.

📦 Technologies

🙌 Contributing

  1. Fork the repository
  2. Create a new branch
git checkout -b feature/your-feature
  1. Commit your changes
git commit -m "Add your message"
  1. Push to the branch
git push origin feature/your-feature
  1. Open a pull request.

⭐ Enjoy crafting with your Notion-like editor!

About

A feature-rich text editor inspired by Notion, built with Tiptap and Y.js.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages