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 design system with a light and a dark theme, a content pipeline that reads your repository, and a scaffold that publishes to GitHub Pages. MIT licensed.
npx docs-sitekit init- Themes
- 2
- Dark and light, with a switch in the header.
- Phone widths tested
- 3
- 320, 360 and 390 px, plus desktop.
- Layers
- 4
- Domain, application, infrastructure and presentation.
- License
- MIT
- Written from scratch.
01 · Why
Why docs-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, the mobile menu and search (loaded on demand) 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
Start
Configuration reference
Every key of sitekit.config.json, with its type, its default, the values it accepts and what it does.
Read
Start
Upgrading
Bring a site that sitekit init made up to the version of the kit you have installed, without losing what you changed.
Read
Options by topic
Options by topic
The same keys as the configuration reference, sorted by what you want to do, each with an example you can paste.
Read
Options by topic
Options: identity and the home page
The keys that say what the site is, and what the home page shows first: site, hero, features and stats.
Read
Options by topic
Options: navigation and collections
The keys that decide what the reader can click: the header menu nav, the footer, the collections of pages, and the sources they are read from.
Read
03 · Components
Components
Every component of the kit with a live preview, the code that produced it, the command to add it and its props.
Foundation
Button
Button and buttonVariants, from shadcn/ui, with the look of the kit.
Read
Foundation
ToneBadge
The only way to show a status color.
Read
Foundation
Icon
A lucide icon by its kebab-case name, or a brand logo as brand:<slug>.
Read
Layout
SectionHeader
Mono eyebrow, heading and lede.
Read
Layout
Hero
Badge, headline, lede, command and actions.
Read
Layout
CtaBand
Closing headline with a command and actions.
Read
04 · Examples
Examples
Working examples you can copy and adapt.