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.15.tar.gz (24.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.15-py3-none-any.whl (28.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mrmd-0.9.15.tar.gz
Algorithm Hash digest
SHA256 539a6e89155182cd500a793f4cd7efbe67db1e8e02aedcfbb6ca2f6399ff9cff
MD5 6ae97a8e1e4564276d823864771fc669
BLAKE2b-256 4e03ba325c19a478b159b0e6dff299ba8579e3d2fde4ad113a659384916cf047

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for mrmd-0.9.15-py3-none-any.whl
Algorithm Hash digest
SHA256 692b4c731d1feeddf70b0186072e1364b34efcb3cb4617568c05dd24cd1a9828
MD5 109afa5dd80d001d118860eeb88fa4aa
BLAKE2b-256 a7a0fb328a71d7f77b35dbb99975b81175529b2be09a9c2957101b4247b307ef

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