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.22.tar.gz (37.5 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.22-py3-none-any.whl (44.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mrmd-0.9.22.tar.gz
Algorithm Hash digest
SHA256 18f465912da6b65ccf4e0839500a3b5ff651b9fa28085f3990d0624b8c324247
MD5 10cc31610b78a8a2ec825168b5c26e34
BLAKE2b-256 8eda4578da365b220f72f2f0ea7853b5d48b2bd33b58c8adcee79576d5c83e6a

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for mrmd-0.9.22-py3-none-any.whl
Algorithm Hash digest
SHA256 cdb606120a410fec67ac398a4e310c31af260c4d9f3a426cf654161ae99c583a
MD5 a7b4cb03f9601f61e5ead6df7686aaa3
BLAKE2b-256 2d241962813ddb03e4443bdde112e44a55c90cc6cfa5e4d21fef818149a4e312

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