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.19.tar.gz (36.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.19-py3-none-any.whl (43.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mrmd-0.9.19.tar.gz
  • Upload date:
  • Size: 36.6 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.19.tar.gz
Algorithm Hash digest
SHA256 43968e4f6a19b8d07f13004c42a3672d31c28da608e7314f52465072d7ac5d75
MD5 4bc61929737f5235abb1151949812249
BLAKE2b-256 7e2b860982e965fcdd15cf44023df4e1eaf17096be87e2c7d72371fe6309f918

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mrmd-0.9.19-py3-none-any.whl
  • Upload date:
  • Size: 43.6 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.19-py3-none-any.whl
Algorithm Hash digest
SHA256 fd30c31e7471c67a00f2ddd130c1cff972ec958b4e5dadea45e1bae7985363e5
MD5 c5c3dab5a27b50637993d7f5611b3658
BLAKE2b-256 32771a966405bd861c3a40827a5e1e3f164b74b70a7eafdcf684677098621121

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