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.10.tar.gz (21.4 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.10-py3-none-any.whl (25.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mrmd-0.9.10.tar.gz
  • Upload date:
  • Size: 21.4 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.10.tar.gz
Algorithm Hash digest
SHA256 424522b1153ea7c3c5cd114d97d7440a22cc427801b5003fe196b3cad52556ad
MD5 f487366cdc97a9ae57962307a988ff87
BLAKE2b-256 d2011fdc5376b4723f13c93b7b4c14a07a0efa618933f0b268c22d56a9c21a00

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mrmd-0.9.10-py3-none-any.whl
  • Upload date:
  • Size: 25.5 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.10-py3-none-any.whl
Algorithm Hash digest
SHA256 5077134aa87dfc9568aeb055ad1e01bbbd78459d2c3483e77d029f48cc94fc98
MD5 f9d3e3793f0ae4a97c56b31a9c18fb21
BLAKE2b-256 49ac1835f26427da79437651d002d92f28310b21465a597e9d798fece930e4d1

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