Skip to content
pagebeampagebeampagebeam docs

pagebeam

pagebeam checks every page against the application it describes, tells you how sure it is, and opens the pull request that fixes what it can. It is open source, and it runs in the repository you already have.

Try it

Section titled “Try it”

Two commands, in the repository holding your documentation:

Terminal window
npx pagebeam init
npx pagebeam check

init writes pagebeam.config.yaml. check reads and reports: nothing is written outside that one file, and nothing reaches a remote.

Section titled “Read next”
  • Getting started: what init works out, and pointing at a product in another repository.
  • Checks: the six checks and what each one compares a page with.
  • Standing: what proven and review mean, and which findings can fail a build.
  • Configuration: every key in pagebeam.config.yaml.
  • Proposals: drafting fixes with a model you choose, and what leaves the machine.
  • CLI reference: commands, profiles and exit codes.