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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mrmd-0.10.1.tar.gz
Algorithm Hash digest
SHA256 33fe9c786dc848f71cbf8e9a043d8858529e1ebe541f0031af2ed94068f98bfe
MD5 a4022c05ab18c9d9f296d470a2ef48d1
BLAKE2b-256 f8cbab7b77c15a1fcd39f637cd9c9a81b1df5dc326e326de5a2d98005c2577c0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mrmd-0.10.1-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.10.12

File hashes

Hashes for mrmd-0.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c6802e7f7410b260d52d181b3ecf6c068ff09a22b388399158c0ea658a470fc2
MD5 c0428ce9d713cbe7700f29a186c43949
BLAKE2b-256 cfc972334e5a02eed17551b2c36597d4449d96b4dc837867ee18e457b3ac4c1a

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