mdzilla

mdzilla

ターミナルやエージェント向けの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 エージェントまたはTTYではない標準出力の場合は自動的に有効になります

スマート解決

2番目の位置引数はスマート解決されます。

1. ナビゲーションパスと一致する場合 → そのページをレンダリングします
2. 一致しない場合 → タイトルと本文を検索します

エージェントでの使用

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