Skip to content
manni

manni

One command line for documentation that is meant to be checked.
Validate metadataFix a failing check

Every command reads manni <domain> <subcommand> [<subcommand>] [<arguments>], and the domain is the tool. manni meta validate docs/ runs the metadata tool’s validate against docs/, and manni meta schemas vendor reaches a verb one level down. Each tool has its own commands, its own section of this site, and its own key in one shared config file, manni.config.yaml. Install the package once and every tool is there.

Terminal window
npm install -D @hawkeyexl/manni
npx @hawkeyexl/manni meta validate docs/

The tools

Section titled “The tools”
metaValidate the presence and format of document metadata against JSON Schema, built for CI. Read, query and fill it too. Formerly published as docmeta.
a11yCrawl a site and check every page for accessibility violations with axe-core, built for CI.
citePin a sentence to the source lines it rests on, and find out when those lines move or change. From git alone, no model, no network.
keySet and rotate the family encryption key, so a required field or a private source path is on the page without being readable there.

meta checks what a page says about itself; cite checks that what a page says about the code is still true. key sets and rotates the one encryption key both of them encrypt values with. More tools are folded in as they become ready to ship. Until one lands, its subcommand does not exist, and manni --help lists exactly what does.

Coming from docmeta?

Section titled “Coming from docmeta?”

The metadata tool used to be the whole package. Three things changed, and nothing else did:

  • The command. docmeta validate … is now manni meta validate …. The package still installs a docmeta bin that runs the same program, so existing scripts keep working while you move them.
  • The config file. manni.config.yaml, with the metadata tool’s keys under meta:. A docmeta.config.yaml is still read, with a warning. See the configuration reference.
  • The GitHub Action. uses: hawkeyexl/manni@v2, with the same inputs.

Every built-in schema keeps its old published URL as well as its new one, so a $schema line written before the rename still resolves offline. See the built-in schema registry.