kage/docs/content/getting-started/_index.md at c5b39d6816db3db4e5228cda11a7d9df342fd4bf

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

413 B

Raw Blame History

title, linkTitle, description, weight, featured

title	linkTitle	description	weight	featured
Getting started	Getting started	Install kage and clone your first site into a browsable offline folder in under a minute.	10	true

Three short pages: how kage thinks about cloning a site (render, strip, localise), how to install the binary and point it at a browser, and a guided first run that ends with a real offline mirror you can click through.

413 B Raw Blame History

413 B

Raw Blame History