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.17.tar.gz (30.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.17-py3-none-any.whl (35.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mrmd-0.9.17.tar.gz
  • Upload date:
  • Size: 30.1 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.17.tar.gz
Algorithm Hash digest
SHA256 1b48eeb33db56844332076ca5ccf3426fd0f3266c712338ab851a67b626cbb16
MD5 3c1c8a1726796241be3f984cd5331e75
BLAKE2b-256 a88d24764bb5ccb85a0daac49abdc66a0f0f89d14ccc4f33ea19b0408c627898

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mrmd-0.9.17-py3-none-any.whl
  • Upload date:
  • Size: 35.4 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.17-py3-none-any.whl
Algorithm Hash digest
SHA256 ee58796ffd838ef4272ab4c094f2c0a1871bf993bea52df0c295faa87d9a6585
MD5 7babdc72b2235d42980ee181f265a54a
BLAKE2b-256 c5d6759e93e122019805aeb608a21186cb448f75e83e7f86a7100840452fcfbc

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