Source for the privacycommand documentation site, built with Mintlify.
Production is a Cloudflare Worker serving the static export as assets
(wrangler.jsonc). just deploy builds and publishes it.
Hostname: docs.privacycommand.privacykey.org (DNS not configured yet)
npm run dev # mint dev, on http://localhost:3000
npm run check # validate docs.json navigation against the files on disk
npm run llms # regenerate llms.txt and llms-full.txt after editing a pagenpm run check is the fast gate — it catches a page listed in docs.json with
no matching file, and a file that exists but isn't in the navigation. Run it
before pushing; CI runs a link check on top.
docs.json navigation, theme, SEO
introduction.mdx … the Guide tab, one file per page
develop/ the Develop tab
images/ logo/ assets
scripts/ check-docs.mjs, build-llms.mjs
llms.txt AI-readable index of every page (generated, committed)
llms-full.txt the whole site as one Markdown file (generated, committed)
The site follows the llms.txt convention. llms.txt at the
repository root indexes every page with its one-line description, and
llms-full.txt is the whole site as one Markdown file. Both are committed, so
they read fine straight from GitHub, and both are served from the site root. The
build also writes every page as plain Markdown beside its HTML, so appending
.md to any page URL returns the Markdown.
scripts/build-llms.mjs generates all of it from docs.json and each page's
frontmatter, using only Node built-ins. Run npm run llms after editing a page
and commit the result; npm run check fails when the committed copies are out
of date.
See CONTRIBUTING.md. Docs for the app itself live in the privacycommand repo — this repo is the site only.
MIT, matching privacycommand. See LICENSE.