Options: content checks and publishing

The keys that decide what blocks a publish and what is kept out of the site: check, anonymize, vars and deploy.

Each key is documented in the configuration reference, under check, anonymize, vars and deploy. This page shows them together and says what they change. What the check reads and what it skips is in Content.

How serious each finding is

{
  "check": {
    "links": "error",
    "excludedLinks": "warning",
    "anchors": "warning",
    "images": "error",
    "frontmatter": "warning",
    "order": "error",
    "duplicateHeadings": "off",
    "callouts": "warning",
    "variables": "error",
    "snippets": "error",
    "card": "error"
  }
}

Each key is a kind of finding, and the value is error, warning or off. The example writes every kind, but you only need to write the ones you want to change: a kind you leave out keeps its default. The highlighted lines are the three that differ from the defaults, a broken link and an undeclared variable that now stop a publish, and repeated headings that are no longer reported.

What the value does:

• error is printed by the build, and sitekit check exits with 1, so a pipeline that runs it stops. The last line of the check says Not safe to publish.
• warning is printed with the file and the line, and the check still ends with Safe to publish.
• off is not reported at all.

The build only prints findings, whatever their severity. The command sitekit check is the one that decides. A name under check that is not a kind fails with the name and the list of kinds.

These are lines that sitekit check prints for a page with one of each problem, with the default severity of each kind:

Keep files and words out of the site

{
  "anonymize": {
    "excludePaths": ["docs/drafts/**"],
    "replace": {
      "BigCorp": "the client",
      "builder.internal": "the build host"
    },
    "denyPatterns": ["PROJ-\\d+"],
    "allow": ["support@acme.example"]
  }
}

Given a page that says The client BigCorp runs on host builder.internal and ticket PROJ-1234 is open. Contact support@acme.example., the example does this:

• excludePaths removes the files that match from the site. A page in docs/drafts/ is not read, so it has no page, no search entry and no line in llms.txt. The globs are relative to sources.root.
• replace swaps each text everywhere it is found, before the page is read. The page above is built as The client the client runs on host the build host and ticket PROJ-1234 is open.
• denyPatterns are regular expressions that sitekit check reports as a leak, besides the credentials and internal hosts it always looks for. The ticket number above is reported as deny-pattern-1, once for the source file and once for each built file that holds it. A leak is an error.
• allow lists exact texts that check accepts although a pattern matches them. Without it, the support address above is reported as an email-address by the built-in patterns. With it, it passes.

Variables

{
  "vars": {
    "product": "Acme",
    "package": "@acme/queue"
  }
}

A page that writes {{ product }} is built with Acme in that place, in prose, headings, link text and the frontmatter. In a code span or a fenced block the text is left as written, so a page can show the syntax. A name that is not declared stays as written and is a variables finding.

{{ version }} needs no entry: its value is site.version, else the version of the package.json at the root of the repository. A version written under vars wins for the text of the pages, and it does not change the v2.4.0 label of the footer, which keeps following site.version.

Where it is published

{
  "deploy": {
    "target": "github-pages",
    "acknowledgePublicPages": true,
    "repositoryVisibility": "private"
  }
}

These keys change what sitekit check says about the repository, and nothing in the pages.

repositoryVisibility is for a runner where check cannot get the answer from GitHub. Without it, and without an answer, the check stops with error: Cannot tell whether the repository is private. Set deploy.repositoryVisibility in sitekit.config.json.