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.20.tar.gz (37.1 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.20-py3-none-any.whl (44.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mrmd-0.9.20.tar.gz
  • Upload date:
  • Size: 37.1 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.20.tar.gz
Algorithm Hash digest
SHA256 8cbd60260bd28aafde75f2409b42de112f943db57af27b2ed631f24ee6bb34de
MD5 0450975041cbca2d35ab06744e423e2e
BLAKE2b-256 ef80e3b96aac7b87d6fd5d685a65cd92f110403fb9b449a9b5b204533abd58b9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mrmd-0.9.20-py3-none-any.whl
  • Upload date:
  • Size: 44.1 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.20-py3-none-any.whl
Algorithm Hash digest
SHA256 8cd6df01e375b62692506f26614e12283ab62db188865e67273ef22acd8eac3b
MD5 74e8b159536080268f3e1745cc7f0875
BLAKE2b-256 e3f9f21cefcc52bb46f2afa88406a40209ac048e0a1a12933a1f0cf84ac3c51e

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