marktion  by microvoid

AI-powered Markdown editor for enhanced editing experience

created 2 years ago
326 stars

Top 84.8% on sourcepulse

GitHubView on GitHub
Project Summary

Marktion is a WYSIWYG Markdown editor built on ProseMirror, designed to enhance the Markdown editing experience with AI integration and a Notion-like interface. It targets developers seeking a feature-rich, extensible editor for web applications, offering real-time preview, slash/bubble menus, and dark mode support.

How It Works

Marktion leverages ProseMirror for its robust WYSIWYG editing capabilities, providing a stable foundation for rich text manipulation. Its core innovation lies in the AI integration, allowing users to invoke AI conversations via a spacebar trigger at the start of a line, with support for AI plugin extensions. This approach offers a seamless blend of traditional Markdown editing with advanced AI assistance directly within the editor.

Quick Start & Requirements

  • Install dependencies: npm install marktion
  • Usage: Import ReactEditor and marktion/dist/style.css in a React component.
  • Prerequisites: Node.js, npm. AI plugin requires Vercel AI setup and an AI router.
  • Documentation: marktion.io

Highlighted Details

  • AI integration with conversation interface and plugin support.
  • WYSIWYG and source code editing modes, switchable via Ctrl + /.
  • Notion-inspired slash and bubble menus for quick actions.
  • Dark mode support for comfortable editing.

Maintenance & Community

Licensing & Compatibility

  • License: MIT License.
  • Compatible with commercial and closed-source applications.

Limitations & Caveats

The AI plugin functionality relies on external setup with Vercel AI and an AI router, requiring additional configuration. The project is presented as an editor component, implying integration into larger applications rather than a standalone product.

Health Check
Last commit

7 months ago

Responsiveness

1+ week

Pull Requests (30d)
0
Issues (30d)
0
Star History
4 stars in the last 90 days

Explore Similar Projects

Feedback? Help us improve.