关于 mdzilla
mdzilla 是面向终端用户和 Agent 的 Markdown 文档浏览技能，可从本地目录、GitHub、npm、HTTP 和 llms.txt 获取并呈现文档。它还支持搜索、纯文本输出及导出为 Markdown 文件。
主要功能
- 01读取本地、GitHub、npm 和 HTTP 文档
- 02解析并呈现文档导航页面
- 03搜索文档标题与内容
- 04以纯文本形式输出
- 05导出 Markdown 文档文件
适用场景
- 01在终端浏览项目文档
- 02为 Agent 检索特定文档页面
- 03搜索文档主题或关键词
- 04导出文档供离线处理
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/mdzilla确认已加载。
详细介绍
mdzilla
面向终端和 Agent 的 Markdown 文档浏览器。可从本地目录、GitHub、npm、HTTP 和 llms.txt 获取并渲染文档。
CLI
npx mdzilla <source> [query] [options]
来源
| 来源 | 语法 | 说明 |
|---|---|---|
| 本地目录 | mdzilla ./docs | 扫描本地文档目录 |
| 文件 | mdzilla README.md | 渲染单个 Markdown 文件 |
| GitHub | mdzilla gh:owner/repo | 查找仓库中的 docs/ |
| npm | mdzilla npm:package-name | 下载软件包并读取文档 |
| HTTP | mdzilla https://example.com | 依次尝试 /llms.txt、Markdown 内容协商，再尝试将 HTML 转为 Markdown |
选项
--export <dir>— 将文档导出为平铺的.md文件--plain— 输出纯文本；用于 AI Agent 或 stdout 不是 TTY 时会自动启用
智能解析
第二个位置参数会进行智能解析：
- 如果与导航路径匹配 → 渲染该页面
- 否则 → 搜索标题和内容
Agent 用法
npx mdzilla gh:unjs/h3 /guide/basics # render a specific page
npx mdzilla gh:unjs/h3 router # search for 'router'
npx mdzilla https://h3.unjs.io /guide # render page from URL
npx mdzilla npm:consola --plain # list all pages (plain)
导出文档以供离线处理：
npx mdzilla <source> --export ./fetched-docs
然后按需读取导出的 .md 文件。
编程 API
导出文档
import { exportSource } from "mdzilla";
await exportSource("./docs", "./dist/docs");
await exportSource("gh:unjs/h3", "./dist/h3-docs");
await exportSource("npm:h3", "./dist/h3-docs", { plainText: true });
await exportSource("https://h3.unjs.io", "./dist/h3-docs");
集合
import { Collection, resolveSource } from "mdzilla";
const docs = new Collection(resolveSource("./docs"));
await docs.load();
console.log(docs.tree); // NavEntry[] navigation tree
console.log(docs.flat); // FlatEntry[] flat list
const content = await docs.getContent(docs.flat[0]);
const results = docs.filter("query"); // fuzzy search
评论
支持 Markdown