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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mrmd-0.9.12.tar.gz
  • Upload date:
  • Size: 21.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.4

File hashes

Hashes for mrmd-0.9.12.tar.gz
Algorithm Hash digest
SHA256 93ba24d28b68003b9909b9c9f66b84ee3e1ae01b644887099a34e4a56a03e777
MD5 b6924c9a5cece0dbee47bd4528a77737
BLAKE2b-256 82b1e2945bfb7aff8e45293ee14119fd3f9972435decb823fe5cbe95df099b8c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mrmd-0.9.12-py3-none-any.whl
  • Upload date:
  • Size: 25.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.4

File hashes

Hashes for mrmd-0.9.12-py3-none-any.whl
Algorithm Hash digest
SHA256 f1d1ead4235e3e5366366840dbad3a8cc0165f65287b8b9febe5d732b72f0a3b
MD5 efe3d19f4225a807c4158435af4e0a26
BLAKE2b-256 a471b5047846674a80564ccbb9a48d93b131fdf7b226d18bca0acd193745b6ca

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