mkdn.pro

Beautiful markdown sharing from your terminal.

Turn any markdown file into a beautifully rendered, shareable webpage in seconds. No account required.

🌐 Website: mkdn.pro

Install

npm install -g mkdn.pro

Or use without installing:

npx mkdn.pro README.md

Quick Start

# Share a markdown file
mkdn README.md

# Share and open in browser
mkdn README.md --open

# Share and copy link to clipboard
mkdn README.md --copy

# Pipe content directly
cat notes.md | mkdn share

Features

• Instant sharing - Get a link in under a second
• Beautiful rendering - 6 themes to choose from
• No account required - Just share and go
• Privacy options - Password protection & expiring links
• CLI-friendly - JSON output, quiet mode for scripting
• Cross-platform - Works on macOS, Linux, and Windows

Usage

# Basic share
mkdn share README.md

# With options
mkdn share doc.md --expires 1h --password secret --theme dark

# Custom URL slug
mkdn share doc.md --slug my-project-docs

# Open in browser automatically
mkdn share doc.md --open

# Copy URL to clipboard
mkdn share doc.md --copy

# JSON output for scripting
mkdn share doc.md --json

# URL only (for scripts)
mkdn share doc.md --quiet

Options

| Option | Description | |--------|-------------| | -o, --open | Open URL in browser | | -c, --copy | Copy URL to clipboard | | -e, --expires <time> | Expiration: 1h, 24h, 7d, 30d (default: 7d) | | -p, --password <pass> | Password protect the document | | -t, --theme <name> | Theme: default, dark, paper, playful, minimal, night-owl | | -s, --slug <custom> | Custom URL slug (3-30 chars) | | -j, --json | Output as JSON | | -q, --quiet | Output URL only |

Config

Set defaults so you don't have to type them every time:

# Set default theme
mkdn config set theme dark

# Set default expiration
mkdn config set expires 24h

# Auto-copy URLs to clipboard
mkdn config set copy true

# View all settings
mkdn config list

Config is stored in ~/.config/mkdn/config.json

Examples

Share and open in browser

mkdn share notes.md --open
# ✓ Document shared!
# https://mkdn.pro/a7bx9k2
# (opens in your default browser)

Use in scripts

URL=$(mkdn share report.md --quiet)
echo "Report available at: $URL"

Pipe from other commands

# Share git diff
git diff | mkdn share --expires 1h

# Share from clipboard (macOS)
pbpaste | mkdn share --open

# Share command output as markdown
echo "# Server Status\n\n\`\`\`\n$(uptime)\n\`\`\`" | mkdn share

Password-protected document

mkdn share secret-notes.md --password mysecret
# Recipient will need to enter password to view

Links

• 🌐 mkdn.pro - Web app
• 📦 npm - Package
• 💻 GitHub - Source code

License

MIT