Skip to content
flc1125Public

About

Markdown in, URL out. Publish Markdown as immutable, shareable web pages with CLI, MCP, and agent skills.

Topics

Resources

Contributing

Security policy

Stars

4 stars

Watchers

0 watching

Forks

Repository files navigation


Mote

Markdown in, URL out.
Publish local Markdown as browser-readable web pages with hard-to-guess URLs.

CI npm npm downloads License: MIT Node ≥ 20

Quick Start • Live Demo • Documentation • Self-hosting • 简体中文


✨ Features

  • 🔒 Immutable — every publish creates a new URL; stored Markdown and uploaded assets cannot be updated
  • 🔑 Capability URL — anyone with the URL can read it; a 94-bit random ID resists guessing, and pages request no indexing
  • 🖼️ Local images — referenced images are uploaded automatically, deduplicated, and served from opaque URLs
  • ⚡ Fast — Cloudflare Workers + R2 + CDN cache; no database, server-rendered documents
  • 🤖 Agent-ready — CLI --json output, plus remote and local MCP servers

Pages remain available only while the instance and its storage operate. Viewer updates can change presentation; remote images depend on their hosts. Search-engine directives are not access control and do not guarantee exclusion from search results.

🚀 Quick Start

Use Mote from the terminal, from an AI agent, or both — pick what fits your workflow.

CLI

With Node.js 20+ and publishing permission on https://mote.pub, create a file named hello.md containing # Hello, Mote, then run from its folder:

npm install -g mote-cli
mote login
mote hello.md
Published:

https://mote.pub/7Vk3mQ9x2NFaP4Ls

Live sample → a project update with images, tables, and code · Markdown source

Open the returned URL to read your page. The URL above illustrates the output; each publication gets a new ID.

Need an instance or help signing in? Follow Publish your first document. For your own Access-enabled instance, log in with mote login --api https://mote.example.com --auth-mode oauth. Instance selection and other authentication modes are covered in authentication.

Full options, configuration, scripting and source installation: CLI reference.

MCP

Point your agent at the remote MCP endpoint — on Access-enabled instances it authenticates over OAuth:

{
  "mcpServers": {
    "mote": {
      "type": "http",
      "url": "https://mote.pub/api/mcp"
    }
  }
}

A local stdio server is also available, adding publish_markdown_file with automatic local-image upload. Setup, tools, and verified clients: docs/mcp.md.

Skill

Teach your agent when and how to publish with Mote:

npx skills add flc1125/mote

The skill drives the CLI or MCP tools — details: docs/skill.md.

📝 Markdown support

  • Tables, task lists, alerts, foldable admonitions and content tabs.
  • Code titles and line highlighting; image widths and captions.
  • Text highlights, definition lists, abbreviations, footnotes and Chinese emphasis compatibility.
  • Math formulas and a supported subset of Mermaid diagrams, with processing limits.

Server-rendered content stays readable without JavaScript. Fixed scripts enhance navigation, code copying, image viewing and footnote previews. CSP restricts these scripts. Document content cannot run scripts.

Compatibility reference and limits · Live compatibility specimen · Markdown source

🏠 Self-hosting

Run your own instance on Cloudflare: docs/self-hosting.md, including free-tier limits and capacity considerations.

📏 Limits

Item Limit
Markdown ≤ 2 MiB
Single image ≤ 10 MiB
Whole bundle ≤ 20 MiB
Uploaded assets ≤ 50
Image formats png / jpeg / webp / gif / avif

1 MiB = 1,048,576 bytes. The CLI counts assets after content deduplication; remote images are not included. The bundle limit is Markdown plus uploaded image bytes. See exact limits.

Uploaded SVG images and raw HTML SVG are not supported. Static Mermaid diagrams use separately sanitized, generated SVG.

📚 Documentation

Production Workers deploy from main through Cloudflare Workers Builds. GitHub Actions handles CI and stable-tag CLI/GitHub releases; see deployment operations.

📄 License

Mote is released under the MIT License.

About

Markdown in, URL out. Publish Markdown as immutable, shareable web pages with CLI, MCP, and agent skills.

Topics

Resources

Contributing

Security policy

Stars

4 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages