kage/docs/content/guides/_index.md at b59f782165596450bdf3b09751ea00a0a63aac36

Files

T

Duc-Tam Nguyen e6afa91e09 Add the clone engine, CLI, tests, CI, and docs

kage renders every page in headless Chrome, snapshots the final
DOM, strips all JavaScript, and localises CSS, images, and fonts
so a site can be browsed offline as a plain folder of files.

The engine is split into small packages:

  urlx      deterministic URL to local-path mapping and scope rules
  sanitize  remove scripts, on* handlers, and javascript: URLs
  asset     rewrite HTML and CSS references, download assets
  browser   headless Chrome pool over the DevTools protocol
  robots    robots.txt matcher
  clone     the orchestrator: a polite resumable breadth-first crawl

The cli package wires a cobra and fang command surface with two
commands, clone and serve. Every pure package has table tests; the
browser and clone packages add Chrome-driven end-to-end tests that
skip when no browser is present or under -short.

CI runs gofmt, vet, build, race tests, golangci-lint, govulncheck,
and a tidy check on Linux and macOS. A goreleaser config fans one
tag out to archives, deb/rpm/apk, a Chromium-bundled GHCR image,
and the package managers. A tago docs site builds to Pages and
Cloudflare.

2026-06-14 18:22:25 +07:00

446 B

Raw Blame History

title, linkTitle, description, weight, featured

title	linkTitle	description	weight	featured
Guides	Guides	Task-oriented walkthroughs for the things people actually do with kage: scoping a crawl, serving a mirror, and resuming a run.	20	true

Each guide is built around a job rather than a flag: keeping a crawl inside the lines, viewing what you cloned, and picking up an interrupted run. They assume you have worked through the quick start.

446 B Raw Blame History

446 B

Raw Blame History