frostbyte_neo/kage
1
0
Fork 0
Code Issues Pull Requests Actions Deployments Models Agent Notes Packages Projects Releases Wiki Activity

Rewrite the README and add a recorded demo

Browse Source 
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.
This commit is contained in:
Duc-Tam Nguyen
2026-06-14 22:25:31 +07:00
parent 5b7f7d9f31
commit 3af26ae0e5
11 changed files with 209 additions and 95 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/content/getting-started/introduction.md
+1 -1
View File
@@ -46,7 +46,7 @@ folder anywhere, open it with no network, and click around.
kage crawls breadth-first from a seed URL, staying within the seed's host (and
optionally its subdomains). It is polite by default: it honours `robots.txt` and
seeds itself from `sitemap.xml`. Output lands in `kage-out/<host>/`, with pages
seeds itself from `sitemap.xml`. Output lands in `$HOME/data/kage/<host>/`, with pages
as `<path>/index.html` and assets under a reserved `_kage/` directory alongside
the crawl state that powers `--resume`.
docs/content/getting-started/quick-start.md
+4 -4
View File
@@ -19,15 +19,15 @@ errors as it goes; the final summary tells you where the mirror landed.
```
kage cloning https://example.com
done kage-out/example.com
done $HOME/data/kage/example.com
pages 12 assets 38
open kage serve kage-out/example.com
open kage serve $HOME/data/kage/example.com
```
## 2. Look at what landed
```bash
ls kage-out/example.com
ls $HOME/data/kage/example.com
```
```
@@ -46,7 +46,7 @@ serve` runs a local static server so everything resolves exactly as it would
live:
```bash
kage serve kage-out/example.com
kage serve $HOME/data/kage/example.com
# open http://127.0.0.1:8800
```