About Docs Vault

How this static documentation portal works.

Docs Vault is a static site that aggregates documentation from multiple open source projects into one searchable portal.

Stack

Astro — static site generator
Starlight — documentation framework
Lucode Starlight — shadcn/ui-inspired theme
Pagefind — full-text search (built into Starlight)

Loaders

Every upstream project is configured in config/projects.mjs. Before each build, loaders clone or pull the source repository into .cache/repos/ and copy transformed Markdown into src/content/docs/<project>/.

Loader	Use case
`git`	Default loader for Starlight/MDX upstream docs
`vue`	Vue.js docs with VitePress syntax cleanup

Add a custom loader by extending GitDocsLoader in loaders/projects/ and registering it in loaders/index.ts.

Commands

npm run build:lite
npm run build
npm run sync -- --only vue

Adding a project

Add an entry to config/projects.mjs
Run npm run sync -- --only <id>
Run npm run build

Use contentExclude in the project config to omit commercial or unwanted doc categories from sync and navigation.