Duc-Tam Nguyen
3af26ae0e5
Rework the README into the house style: badges, a one-line pitch, an anchor nav, a commands table, and dedicated sections for clone, pack, and the native viewer. Every flag and default is checked against the current binary so the docs match what kage actually does. Add a demo recorded with ascii-gif. The tape clones example.com, packs it to a ZIM and to a self-contained binary, and serves it back offline, so the whole loop reads in one frame. It sits at the top of the README and on the docs home. While reviewing the docs, fix the output path everywhere: the default is $HOME/data/kage, not the kage-out the pages claimed, including a few fabricated 'done kage-out/...' lines. Document pack, open, and the native viewer in the release notes.
46 lines
2.4 KiB
Markdown
46 lines
2.4 KiB
Markdown
---
|
|
title: "kage"
|
|
description: "kage (影, shadow) clones any website into a self-contained folder you can browse offline, with all the JavaScript stripped out. Render in headless Chrome, remove every script, localise the CSS, images, and fonts, from one pure-Go binary."
|
|
heroTitle: "A website, frozen as a shadow"
|
|
heroLead: "kage renders every page in headless Chrome, snapshots the final DOM, removes every script and event handler, and downloads and rewrites the CSS, images, and fonts. The result looks like the live site but runs no code: a plain folder of .html files you can open straight from disk."
|
|
heroPrimaryURL: "/getting-started/quick-start/"
|
|
heroPrimaryText: "Get started"
|
|
---
|
|
|
|
Saving a page with "Save As" gives you a copy that still phones home, still runs
|
|
analytics, and often renders blank because the markup is built by JavaScript at
|
|
runtime. kage (影, "shadow") takes the opposite approach: it drives a real
|
|
browser, captures the page the way a human would have seen it, then makes it
|
|
inert.
|
|
|
|
```bash
|
|
kage clone example.com
|
|
kage serve $HOME/data/kage/example.com
|
|
```
|
|
|
|
|
|
|
|
## What it does
|
|
|
|
- **Renders first, saves second.** Each page goes through real headless Chrome,
|
|
so a page whose content is assembled by JavaScript is captured fully, not as
|
|
an empty shell.
|
|
- **Strips every script.** Once the DOM is captured, kage removes all `<script>`
|
|
tags, every `on*` event handler, and any `javascript:` URL. The saved page
|
|
makes no network calls and runs no code.
|
|
- **Keeps the layout.** Stylesheets, images, fonts, and media are downloaded and
|
|
rewritten to relative local paths, so the offline copy looks like the original.
|
|
- **Stays browsable.** In-scope links are rewritten to point at the other saved
|
|
pages, so you can click around the mirror exactly as you would the live site.
|
|
|
|
## Where to go next
|
|
|
|
- New here? Start with the [introduction](/getting-started/introduction/), then
|
|
the [quick start](/getting-started/quick-start/).
|
|
- Want to install it? See [installation](/getting-started/installation/).
|
|
- Looking for a specific task? The [guides](/guides/) cover scoping a crawl,
|
|
serving a mirror, resuming an interrupted run, and
|
|
[packing a mirror](/guides/packing-a-mirror/) into one file or a self-contained
|
|
viewer.
|
|
- Need every flag? The [CLI reference](/reference/cli/) is the full surface.
|