mdorigin
Use this skill when you want to work on a markdown-first publishing site powered by mdorigin.
Install
Global install:
CODEBLOCK0
Project-local install:
CODEBLOCK1
What it covers
- - local preview with INLINECODE1
- directory index generation with INLINECODE2
- search index generation with INLINECODE3
- Cloudflare Worker bundle output with INLINECODE4
- external binary deployment flow for Cloudflare Assets + R2
- markdown and HTML route behavior, including INLINECODE5
Quick commands
CODEBLOCK2
External binary deploy flow:
CODEBLOCK3
Remote docs
When an agent needs details, prefer the published docs instead of duplicating everything in the skill:
- - HTML docs: INLINECODE6
- Raw markdown home: INLINECODE7
- Routing docs: INLINECODE8
- Configuration docs: INLINECODE9
- Extensions docs: INLINECODE10
- Cloudflare docs: INLINECODE11
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: INLINECODE13
- OpenAPI schema: INLINECODE14
Examples:
CODEBLOCK4
mdorigin
当你需要在一个由 mdorigin 驱动的、以 Markdown 优先的发布站点上工作时,请使用此技能。
安装
全局安装:
bash
npm install -g mdorigin
项目本地安装:
bash
npm install --save-dev mdorigin
涵盖内容
- - 使用 mdorigin dev 进行本地预览
- 使用 mdorigin build index 生成目录索引
- 使用 mdorigin build search 生成搜索索引
- 使用 mdorigin build cloudflare 输出 Cloudflare Worker 打包文件
- 适用于 Cloudflare Assets + R2 的外部二进制部署流程
- Markdown 和 HTML 路由行为,包括 Accept: text/markdown
快速命令
bash
mdorigin dev --root docs/site
mdorigin build index --root docs/site
mdorigin build search --root docs/site
mdorigin build cloudflare --root docs/site
外部二进制部署流程:
bash
mdorigin build cloudflare --root docs/site --binary-mode external
mdorigin sync cloudflare-r2 --dir dist/cloudflare --bucket
mdorigin init cloudflare --dir . --r2-bucket
远程文档
当代理需要详细信息时,建议直接查阅已发布的文档,而不是在技能中重复所有内容:
- - HTML 文档:https://mdorigin.jolestar.workers.dev
- 原始 Markdown 首页:https://mdorigin.jolestar.workers.dev/README.md
- 路由文档:https://mdorigin.jolestar.workers.dev/concepts/routing.md
- 配置文档:https://mdorigin.jolestar.workers.dev/reference/configuration.md
- 扩展文档:https://mdorigin.jolestar.workers.dev/guides/extensions.md
- Cloudflare 文档:https://mdorigin.jolestar.workers.dev/guides/cloudflare.md
当客户端发送 Accept: text/markdown 时,无扩展名的路由也会返回 Markdown 内容。
搜索
当你需要先找到正确的文档页面再打开时,请使用搜索功能:
- - 搜索 API:https://mdorigin.jolestar.workers.dev/api/search?q=
- OpenAPI 模式:https://mdorigin.jolestar.workers.dev/api/openapi.json
示例:
bash
curl https://mdorigin.jolestar.workers.dev/api/search?q=cloudflare%20deploy
curl -H Accept: text/markdown https://mdorigin.jolestar.workers.dev/guides/getting-started