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.14.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.14-py3-none-any.whl (28.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mrmd-0.9.14.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.14.tar.gz
Algorithm Hash digest
SHA256 80fb821a86bf95833868556eff95a8556a2f95ab7aba90ad3cdfdab5284fb133
MD5 99dd9b0a5a667db9b3d2698c098f63f0
BLAKE2b-256 deef4974285fc68c2de43a4107eab26e7cdb7f25971d30248dad396de02ccb78

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mrmd-0.9.14-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.14-py3-none-any.whl
Algorithm Hash digest
SHA256 acae9df7ec1a6d4486779bea43c7cd49619a99db8e764d0f9d9383dd2ab0270d
MD5 28be7fe7c73f081317bb7851e55f42bc
BLAKE2b-256 e4128cba210209ce56bbf7089674ccde662ef09d2c0cc86f560ac1a539c79c68

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