Design system
Tokens and components you own
Components are copied into your site, shadcn style. Edit them freely. One tokens file drives every color, radius and font.
Astro · Tailwind · shadcn/ui · lucide
Documentation sites that look like a product.
A dark design system, a content pipeline that reads your repository, and a scaffold that publishes to GitHub Pages. MIT licensed.
npx docs-sitekit init01 · Why
Why sitekit
Your repository is the source
Docs from the files you already have
Markdown in docs, examples and the changelog becomes pages. Relative links keep working on GitHub and on the site.
Safe to publish
A closed contract and a publish check
Unknown config keys fail the build. A scan looks for credentials and internal hosts before anything is deployed.
Fast by default
Static HTML, almost no JavaScript
Every route is a real HTML file with its own title. Only the copy buttons and the mobile menu ship JavaScript.
02 · Docs
Docs
Guides and reference for using sitekit.
Start
Getting started
Create a documentation site for a repository in a few minutes.
Read
Design system
Components
The design system is a set of React components, written in the shadcn style and rendered at build time. Only the copy button and the mobile menu hydrate.
Read
Design system
Design tokens
design/tokens.json is the single source of truth for colors, radius, fonts, layout and motion. npm run build:tokens turns it into CSS variables.
Read
Content
Content
How a markdown file becomes a page.
Read
Content
Deploying
The site is static, so GitHub Pages serves it directly.
Read
03 · Examples
Examples
Working examples you can copy and adapt.