mdorigin

Use this skill when you want to work on a markdown-first publishing site powered by mdorigin.

Install

Global install:

npm install -g mdorigin

Project-local install:

npm install --save-dev mdorigin

What it covers

• local preview with mdorigin dev
• directory index generation with mdorigin build index
• search index generation with mdorigin build search
• Cloudflare Worker bundle output with mdorigin build cloudflare
• external binary deployment flow for Cloudflare Assets + R2
• markdown and HTML route behavior, including Accept: text/markdown
• built-in /sitemap.xml and /feed.xml when siteUrl is configured

Quick commands

mdorigin dev --root docs/site
mdorigin build index --root docs/site
mdorigin build search --root docs/site
mdorigin build cloudflare --root docs/site

External binary deploy flow:

mdorigin build cloudflare --root docs/site --binary-mode external
mdorigin sync cloudflare-r2 --dir dist/cloudflare --bucket <bucket-name>
mdorigin init cloudflare --dir . --r2-bucket <bucket-name>

Cloudflare search deploy flow:

mdorigin build search --root docs/site --out dist/search
mdorigin build cloudflare --root docs/site --search dist/search --binary-mode external
mdorigin sync cloudflare-r2 --dir dist/cloudflare --bucket <bucket-name>
mdorigin init cloudflare --dir . --r2-bucket <bucket-name>

When build cloudflare is given --search, the search bundle is staged outside worker.mjs; larger search files can also require the R2 sync step.

Remote docs

When an agent needs details, prefer the published docs instead of duplicating everything in the skill:

• HTML docs: https://mdorigin.jolestar.workers.dev
• Raw markdown home: https://mdorigin.jolestar.workers.dev/README.md
• Routing docs: https://mdorigin.jolestar.workers.dev/concepts/routing.md
• Configuration docs: https://mdorigin.jolestar.workers.dev/reference/configuration.md
• Extensions docs: https://mdorigin.jolestar.workers.dev/guides/extensions.md
• Cloudflare docs: https://mdorigin.jolestar.workers.dev/guides/cloudflare.md

Extensionless routes also return markdown when the client sends Accept: text/markdown.

Search

Use search when you need the right doc page before opening it:

• Search API: https://mdorigin.jolestar.workers.dev/api/search?q=<query>
• OpenAPI schema: https://mdorigin.jolestar.workers.dev/api/openapi.json
• Metadata filters: /api/search?q=<query>&meta.type=post or mdorigin search --index dist/search --meta type=post <query>
• Repeated local rebuilds can use mdorigin build search --root docs/site --incremental
• Site-level search defaults such as topK, mode, minScore, reranker, and score adjustment live in mdorigin.config.*; see the configuration docs for details
• Sites can also add optional query-aware search policy rules such as shortQuery and longQuery in mdorigin.config.*

Examples:

curl 'https://mdorigin.jolestar.workers.dev/api/search?q=cloudflare%20deploy'
curl -H 'Accept: text/markdown' 'https://mdorigin.jolestar.workers.dev/guides/getting-started'