roughdraft  by Lex-Inc

Local markdown editor for AI-powered document collaboration

Created 1 month ago
353 stars

Top 79.0% on SourcePulse

GitHubView on GitHub
Project Summary

Roughdraft offers a local-first markdown editor and viewer, enabling users and AI agents to collaboratively review and edit .md files directly on their machines. It solves the problem of proprietary formats and cloud-based workflows by providing a privacy-focused, direct-to-file editing experience for markdown documents. This tool is ideal for developers, writers, and AI researchers who need a streamlined, local workflow for document iteration and feedback.

How It Works

Roughdraft operates on a local-first principle, allowing direct interaction with standard markdown files on your filesystem. It employs an extended CriticMarkup syntax for inline comments, suggested edits, and review discussions, ensuring all annotations are embedded within the .md file itself. This approach maintains compatibility with other markdown editors and facilitates a robust workflow where AI agents can directly read and respond to feedback embedded in the markdown.

Quick Start & Requirements

  • Primary install / run command: npm i -g roughdraft, roughdraft start (background server), roughdraft open ./path/to/file.md (open file).
  • Non-default prerequisites: Node.js and npm.
  • Links: Official setup guide at https://roughdraft.md/setup.md; a live browser-based demo is available.

Highlighted Details

  • Local-First & Privacy: Runs entirely on the user's machine, requiring no cloud services, accounts, or telemetry.
  • Direct Markdown Editing: Works directly with .md files, preserving them as plain text compatible with any markdown editor.
  • AI Agent Integration: Features a CLI and URL-based interface designed for seamless integration with AI agents for automated document review and revision workflows.
  • Extended CriticMarkup: Supports standard CriticMarkup, enhanced with inline ID references and YAML endmatter for structured, round-trippable review data.

Maintenance & Community

  • Developed by Nathan Baschez.
  • Releases are managed via GitHub Actions, publishing to npm. No specific community channels (e.g., Discord, Slack) are listed.

Licensing & Compatibility

  • License type: MIT License.
  • Compatibility notes: The MIT license is permissive, allowing for commercial use and integration into closed-source projects.

Limitations & Caveats

The MCP server is noted as experimental. Roughdraft does not edit specific user-level agent configuration files (e.g., ~/CLAUDE.md). The AI integration workflow relies on specific CLI commands and events like Done Reviewing for handoff.

Health Check
Last Commit

1 week ago

Responsiveness

Inactive

Pull Requests (30d)
18
Issues (30d)
24
Star History
336 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.