The site is built on VitePress
npm ci
npm run docs:dev # live-reloading dev server
npm run docs:build # production build into .vitepress/dist
npm run docs:preview # serve the production build locallyPushing to master deploys the site to GitHub Pages.
| Path | What it is |
|---|---|
index.md |
The home page. The hero terminal is a component, the rest is Markdown. |
docs/ |
The documentation. docs/overview.md is served at /docs/. |
.vitepress/config.mts |
Navigation, sidebar and metadata. |
.vitepress/theme/ |
The theme: custom.css, and the Vue components in components/ (registered globally in index.ts). |
Pages mark the features that are on the main branch of kubepattern/kubepattern but not in a tagged release with <span class="kp-tag">next release</span>, and with a Not in a tagged release yet callout in docs/core/lifecycle.md, docs/getting-started.md, docs/core/patterns.md and docs/core/registry.md. Once they ship, find and remove them, and the list in Try unreleased features in docs/getting-started.md:
grep -rn "next release\|Not in a tagged release" docs index.md