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.8.tar.gz (21.2 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.8-py3-none-any.whl (25.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mrmd-0.9.8.tar.gz
Algorithm Hash digest
SHA256 5fdd5b1479d6d9984eddec8b4307aef301d907f3482271d64cd3f0b4efc108f1
MD5 cb6c76ddbb4b195657ebcfb06956cf53
BLAKE2b-256 af0b5a887f8a73029849ec8eb2973e2f44c05ca56a4e48b415a86399fae7e862

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for mrmd-0.9.8-py3-none-any.whl
Algorithm Hash digest
SHA256 a57f2ddd3195f031b1c1554410c109b894fc9c77aa5a17d1791f37ccdece864d
MD5 dd9aa1da5a0d0d919f761dd85fce7702
BLAKE2b-256 d7715d12b93684472dacbf1783ea75a4b7d1814ca4f91a30a378ed7e74f856c2

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