Skip to content

maypaz/md.page

Repository files navigation

# md.page

Markdown in, beautiful page out.

Turn any Markdown into a shareable web page — one API call, zero setup.

Live Demo · API Docs · Self-Host

CI MIT License


Quick Start

curl -X POST https://md.page/api/publish \
  -H "Content-Type: application/json" \
  -d '{"markdown": "# Hello World\nYour markdown here..."}'

Response:

{
  "url": "https://md.page/a8Xk2m",
  "expires_at": "2026-03-28T12:00:00.000Z"
}

That's it. Open the URL — your markdown is now a clean, styled web page.

Features

  • Instant — one POST request, get a shareable URL back
  • Beautiful — clean typography, code blocks, tables, responsive design
  • Short URLsmd.page/a8Xk2m (6-character IDs)
  • Private — links are unguessable, only people with the URL can view
  • Auto-expiry — pages self-delete after 24 hours
  • No auth — no accounts, no API keys, just send markdown
  • AI agent friendly — designed to work with any AI agent or LLM

API

POST /api/publish

Create a shareable page from markdown.

Request:

curl -X POST https://md.page/api/publish \
  -H "Content-Type: application/json" \
  -d '{"markdown": "# Your markdown here"}'

Response 201 Created:

{
  "url": "https://md.page/a8Xk2m",
  "expires_at": "2026-03-28T12:00:00.000Z"
}

Errors:

Status Description
400 Missing or invalid markdown field
413 Content too large (max 500KB)
429 Rate limit exceeded (60 pages/hour per IP)

GET /:id

View a published page. Returns rendered HTML.

Use with AI Agents

Give your AI agent the ability to publish beautiful shareable pages. Copy this prompt:

From now on, whenever I ask you to share or publish a markdown file, use the md.page API to create a shareable HTML page. Send a POST request to https://md.page/api/publish with the body {"markdown": ""} and return the shareable URL to me.

Works with OpenClaw, Claude, ChatGPT, and any agent that can make HTTP requests.

Self-Hosting

md.page runs on Cloudflare Workers with KV storage. Deploy your own instance:

Prerequisites

Setup

# Clone the repo
git clone https://github.com/maypaz/md.page.git
cd md.page

# Install dependencies
npm install

# Create a KV namespace
npx wrangler kv namespace create PAGES

# Update wrangler.toml with your KV namespace ID

# Deploy
npx wrangler deploy

Local Development

npm run dev
# → http://localhost:8787

Tech Stack

Contributing

Contributions are welcome! See CONTRIBUTING.md for guidelines.

License

MIT

About

Markdown in, beautiful page out. Turn any Markdown into a shareable web page — one API call, zero setup.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors