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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mrmd-0.9.21.tar.gz
Algorithm Hash digest
SHA256 a827e5a3d325dd4645e77ffe3e2ea8c31a1df321796fa64f64498cd74d607051
MD5 51f290a95e85931136ae828c76d4d44e
BLAKE2b-256 a083ed1f1c1809c5ff7c9e83ae4a256896cee14d31f7ce19fa857ea289ef9329

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for mrmd-0.9.21-py3-none-any.whl
Algorithm Hash digest
SHA256 49806e840ce36469b37eeca18d06c814294046e51c072cbfa5b53d1282ca108c
MD5 3e9ed9d6d2d41bbcbdb7f3f0591d5205
BLAKE2b-256 074ea7a48a7073b8704a468a0bfb08f5eedb024b7359989715fc29c2db04c26f

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