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.13.tar.gz (24.0 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.13-py3-none-any.whl (28.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mrmd-0.9.13.tar.gz
  • Upload date:
  • Size: 24.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.4

File hashes

Hashes for mrmd-0.9.13.tar.gz
Algorithm Hash digest
SHA256 115495a75a41b8852e26c1476d1ecb588c3f254422941dcb80ab936a0f4c6cf1
MD5 d54ec436d8a32f2d36fe6fa6d4aa7fcb
BLAKE2b-256 f3bec27f01755353545116898ef11f8e46ce6ea9f7f364bf6af1c0d600baa1dd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mrmd-0.9.13-py3-none-any.whl
  • Upload date:
  • Size: 28.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.4

File hashes

Hashes for mrmd-0.9.13-py3-none-any.whl
Algorithm Hash digest
SHA256 e6ad316e74d223cc35759b16a35e6a31727e36e09a0553313529530c1f2cc012
MD5 77adef9988539a5e0f3cda9e6df243ff
BLAKE2b-256 f45c43c09cdf5857cd89049b3f574e8003ec08bc2ccae9d4af06bca384e38a44

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