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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mrmd-0.9.9.tar.gz
  • Upload date:
  • Size: 21.2 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.9.tar.gz
Algorithm Hash digest
SHA256 2c07fc1a9ce540059675f42ed0e675f8f16f1198bbe46d0aac8d6eb10d676949
MD5 b000bd6b0e76e041aa1f96e2282351ce
BLAKE2b-256 27f962672b67c3a902278fce555b1e6098f5983a1c1c8656309fa76067ed7174

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mrmd-0.9.9-py3-none-any.whl
  • Upload date:
  • Size: 25.2 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.9-py3-none-any.whl
Algorithm Hash digest
SHA256 21c2090f085e44e7e75a0a9e3ea32be892b1dc958dc4b612284b99be82c20b08
MD5 6fd0059100f73b01413588075d687536
BLAKE2b-256 dbbebc6833e7cf013a2e6beeb4e2c18a6537efbe5e526ffcd6d753146fc47ce2

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