mdzilla 0.0.0 → 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Pooya Parsa <pooya@pi0.io>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,142 @@
+<p align="center">
+  <img src=".assets/logo.svg" alt="mdzilla" width="200" height="200">
+</p>
+
+<h1 align="center">mdzilla</h1>
+
+<p align="center">
+Markdown browser for humans and agents.
+</p>
+
+<p align="center">
+
+</p>
+
+> Browse docs from local directories, GitHub repos, and remote websites — all from your terminal. Built on [md4x](https://github.com/unjs/md4x), [mdream](https://github.com/harlan-zw/mdream), [giget](https://github.com/unjs/giget) and [speed-highlight](https://github.com/speed-highlight/core).
+
+Supports any website with [`/llms.txt`](https://llmstxt.org/) or markdown content negotiation.
+
+Works best with [Docus](https://docus.dev)/[Undocs](https://undocs.pages.dev/) docs sources.
+
+## Quick Start
+
+```sh
+npx mdzilla <dir>                 # Browse local docs directory
+npx mdzilla <file.md>             # Render a single markdown file
+npx mdzilla gh:owner/repo         # Browse GitHub repo docs
+npx mdzilla npm:package-name      # Browse npm package docs
+npx mdzilla https://example.com   # Browse remote docs via HTTP
+```
+
+## Agent Skill
+
+Install the mdzilla skill for AI agents using:
+
+```sh
+npx skills install pi0/mdzilla
+```
+
+## Features
+
+### Multiple Sources
+
+| Source          | Syntax                       | Description                       |
+| :-------------- | :--------------------------- | :-------------------------------- |
+| **Local**       | `mdzilla ./docs`             | Scan a local docs directory       |
+| **Single file** | `mdzilla README.md`          | Render a single markdown file     |
+| **GitHub**      | `mdzilla gh:unjs/h3`         | Download and browse a GitHub repo |
+| **npm**         | `mdzilla npm:h3`             | Browse an npm package's docs      |
+| **HTTP**        | `mdzilla https://h3.unjs.io` | Browse remote docs via HTTP       |
+
+### Export
+
+Flatten any docs source into plain `.md` files:
+
+```sh
+npx mdzilla <source> --export <outdir>
+```
+
+### Headless Mode
+
+Use `--plain` for non-interactive output — auto-enabled when called by AI agents or when stdout is not a TTY.
+
+### Keyboard Controls
+
+<details>
+<summary><strong>Browse mode</strong></summary>
+
+| Key                   | Action               |
+| :-------------------- | :------------------- |
+| `↑` `↓` / `j` `k`     | Navigate entries     |
+| `Enter` / `Tab` / `→` | Focus content        |
+| `Space` / `PgDn`      | Page down            |
+| `b` / `PgUp`          | Page up              |
+| `g` / `G`             | Jump to first / last |
+| `/`                   | Search               |
+| `t`                   | Toggle sidebar       |
+| `q`                   | Quit                 |
+
+</details>
+
+<details>
+<summary><strong>Content mode</strong></summary>
+
+| Key                 | Action                |
+| :------------------ | :-------------------- |
+| `↑` `↓` / `j` `k`   | Scroll                |
+| `Space` / `PgDn`    | Page down             |
+| `b` / `PgUp`        | Page up               |
+| `g` / `G`           | Jump to top / bottom  |
+| `/`                 | Search in page        |
+| `n` / `N`           | Next / previous match |
+| `Tab` / `Shift+Tab` | Cycle links           |
+| `Enter`             | Open link             |
+| `Backspace` / `Esc` | Back to nav           |
+| `q`                 | Quit                  |
+
+</details>
+
+<details>
+<summary><strong>Search mode</strong></summary>
+
+| Key     | Action           |
+| :------ | :--------------- |
+| _Type_  | Filter results   |
+| `↑` `↓` | Navigate results |
+| `Enter` | Confirm          |
+| `Esc`   | Cancel           |
+
+</details>
+
+## Programmatic API
+
+```js
+import { DocsManager, DocsSourceFS } from "mdzilla";
+
+const docs = new DocsManager(new DocsSourceFS("./docs"));
+await docs.load();
+
+// Browse the navigation tree
+console.log(docs.tree);
+
+// Get page content
+const content = await docs.getContent(docs.flat[0]);
+```
+
+## Development
+
+<details>
+
+<summary>Local development</summary>
+
+- Clone this repository
+- Install latest LTS version of [Node.js](https://nodejs.org/en/)
+- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
+- Install dependencies using `pnpm install`
+- Run interactive tests using `pnpm dev`
+
+</details>
+
+## License
+
+Published under the [MIT](https://github.com/pi0/mdzilla/blob/main/LICENSE) license.