docusaurus-site-contract

Internal workspace package that owns the reusable Docusaurus site-contract validator used by this template repository.

Purpose

This package centralizes the validation engine and CLI so copied repositories do not need to keep the implementation split across multiple unrelated root files.

The intended long-term reuse model is:

• keep the validator engine and CLI in a package
• keep one repo-local contract file near the docs site
• keep one root script that runs the contract check

Exports

Library

import {
  defineDocusaurusSiteContract,
  formatDocusaurusSiteContractViolations,
  validateDocusaurusSiteContract,
} from "docusaurus-site-contract";

CLI

docusaurus-site-contract --config docs/docusaurus/site-contract.config.mjs

Init bootstrap

node packages/docusaurus-site-contract/cli.mjs init --root .

The init subcommand is intended for private local reuse across template-derived repositories. It can:

• vendor the local package into packages/docusaurus-site-contract
• create docs/docusaurus/site-contract.config.mjs
• create a maintainer guide page under docs/docusaurus/site-docs/developer/
• patch root/docs workspace package scripts

Notes

• This package is currently private because it is intended to ship inside this template repository first.
• If you later publish it to npm, review the package name, README examples, and release workflow first.