Docs
Guides and reference for using sitekit.
30 of 30 shown.
Start
Getting started
Create a documentation site for a repository in a few minutes.
Configuration reference
Every key of sitekit.config.json, with its type, its default, the values it accepts and what it does.
Upgrading
Bring a site that sitekit init made up to the version of the kit you have installed, without losing what you changed.
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.
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.
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.
Options: theme and design
One key picks the theme a visitor sees first: theme.default. Everything else about the look is in design/tokens.json, not in the config.
Options: search and llms.txt
Two features of the site that you can turn on or off: the search dialog with search, and the map for language models with llms.
Options: content checks and publishing
The keys that decide what blocks a publish and what is kept out of the site: check, anonymize, vars and deploy.
Options: edit link and dates
Two lines at the foot of a page: a link to its source file on the repository host, with editLink, and the date of the last change, with lastUpdated.
Options: brand logos
A brand logo is not a key of its own. It is a value of icon, in the cards of the features list.
Extending your site
Extending your site
A site made by sitekit init is yours, so you can add to it. These guides show six things people add, each one small and each one run as a test.
Add an interactive page
Add a page that is not markdown, such as a configurator, a calculator or a playground, with its own script and styles.
Add a collection
Add a set of pages with its own place in the menu, and decide the order and the groups of its sidebar.
Change a component, and keep the change
Add a component with add, change it, and see what add and sitekit upgrade do to the file you changed.
Change the tokens
Give the site a new accent in design/tokens.json, rebuild the CSS, and check the contrast of the new colors.
Add a logo and a layout of your own
Draw a brand logo the kit does not ship, and give one collection a page layout of your own.
Keep the build safe
Know what sitekit check looks for before a site is published, and add a rule of your own to the closed config.
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 hydrates. The mobile menu is a native dialog and a few lines of script,…
Brand logos
The icon of a feature in sitekit.config.json is a lucide name, and lucide has no brand logos. A logo is written as brand: instead:
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.
A detail page with a side card
A page with a card of metadata beside its text, written in the frontmatter.
Performance
A page of a generated site is drawn on a phone in about 2 seconds in Lighthouse's mobile test, and nothing on it moves when the web font arrives. This page says how the fonts and the menu are built…
Content
Content
How a markdown file becomes a page.
Callouts
Highlight a note, a tip or a warning in a page, with plain markdown.
Code blocks
A title, highlighted lines, added and removed lines, and a button that copies the code, all written in the fence.
Deploying
The site is static, so GitHub Pages serves it directly.
Search
Every site has a search dialog. A reader opens it with the search button in the header, with Ctrl K or Cmd K, or with the slash key when no field has the focus.
llms.txt
An optional map of the site for language models, written as Markdown.
Edit this page and the date of the last change
A link at the foot of each page to its source file, and the date the file last changed.