Skip to main content

Collaborative markdown notebooks - edit and run code together

Project description

mrmd

Collaborative markdown notebooks - edit and run code together.

Quick Start

# Run directly with uvx (no install needed)
uvx mrmd

# Or install and run
pip install mrmd
mrmd

What it does

mrmd opens a collaborative markdown editor in your browser. You can:

  • Write markdown with live preview
  • Add executable code blocks (Python, JavaScript, etc.)
  • Collaborate in real-time with others
  • Run code and see output inline

Usage

# Open editor in current project
mrmd

# Use custom docs directory
mrmd --docs ./notes

# Use custom port
mrmd --port 3000

# Don't open browser automatically
mrmd --no-browser

How it works

mrmd automatically detects your project root by looking for common markers:

  • .git - Git repository
  • .venv - Python virtual environment
  • pyproject.toml - Python project
  • package.json - Node.js project
  • etc.

It then:

  1. Starts a sync server for real-time collaboration (Yjs/CRDT)
  2. Starts a Python runtime for code execution
  3. Serves the editor UI
  4. Opens your browser

Documents are saved to the docs/ directory in your project (or notebooks/, notes/ if they exist).

Development

# Clone the repo
git clone https://github.com/anthropics/mrmd-packages
cd mrmd-packages/mrmd

# Install in development mode
uv pip install -e .

# Run
mrmd

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mrmd-0.9.18.tar.gz (30.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mrmd-0.9.18-py3-none-any.whl (35.9 kB view details)

Uploaded Python 3

File details

Details for the file mrmd-0.9.18.tar.gz.

File metadata

  • Download URL: mrmd-0.9.18.tar.gz
  • Upload date:
  • Size: 30.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for mrmd-0.9.18.tar.gz
Algorithm Hash digest
SHA256 5c78c6c9424cc3097787183e4a424c376d30573c6236a9bdf629b1dc666a3bd8
MD5 6a7d88b13b03207bf93cf4cdd6f51962
BLAKE2b-256 3a7cba50c1d4285dd054fa7e4ca86a967e926832a8649f89ac348c6ac39a0573

See more details on using hashes here.

File details

Details for the file mrmd-0.9.18-py3-none-any.whl.

File metadata

  • Download URL: mrmd-0.9.18-py3-none-any.whl
  • Upload date:
  • Size: 35.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for mrmd-0.9.18-py3-none-any.whl
Algorithm Hash digest
SHA256 201423f33d48cdda0af6bcdb7d66b75a8b4e1cacb7d7eb3ae410dcc64aba22d0
MD5 892dd1f7688b0d6e5fef015b54fa7ba7
BLAKE2b-256 b0d0e2d4ae27c93616d6cc3c9ed999c2dd375606dd4e83c8c56bcd16932e2485

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page