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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mrmd-0.9.3.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.3.tar.gz
Algorithm Hash digest
SHA256 0170bd295b2a9bd7bfd477f1f5774c309370122501a8c61a64a92c94eff4411f
MD5 ec66ee230884f1ce081433f9f1cc1716
BLAKE2b-256 1405201c35a74bd7e159e5dc684c4b5227645395efaa2438d320fde3b598c832

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mrmd-0.9.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b696137fa574687c9e38c022bf13ccd2f85ed23c10b0fc5e3ad83419f8193c7a
MD5 d331fd1564e20ae293668dcde61c17da
BLAKE2b-256 20470ea562f4140bc6fa0330336f87318cdb3357fb57bbc89f97e43ffeca1f10

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