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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mrmd-0.9.7.tar.gz
  • Upload date:
  • Size: 21.0 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.7.tar.gz
Algorithm Hash digest
SHA256 22ae9a05a7095c038ca3cdd5232377b7d6215fca6daead6c556233880c9431d8
MD5 e449f68cbf94490e3e05fe878b91fd38
BLAKE2b-256 a27d2ad95fcb3c2fef0b40d83acca7d338bf36cb5b5c7a5c5185a37114c6be94

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mrmd-0.9.7-py3-none-any.whl
  • Upload date:
  • Size: 24.6 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 ad36b477d6ac8aff6f9d72d4ba06c31b95d99aca5a17469f3aae2117c8c76857
MD5 0fb4d966d626284846c220c9e89ca369
BLAKE2b-256 1655e2352bfd5860156e60f76120218a9e1bb2658900f0a5e22a039fc95d2b41

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