Guide

Getting started

kb works with zero config. Point it at a directory of markdown files:

kb dev                      # looks for docs/, falls back to .
kb dev --content-dir wiki   # or specify explicitly

When you need more control, add a kb.config.ts.

Organizing content

Your file structure is your sidebar — directories become collapsible folders, markdown files become pages:

Each file maps to a URL: getting-started.md → /getting-started, guides/deployment.md → /guides/deployment.

Section pages

A directory's index.md provides the content for that folder's page. Without one, the folder still appears in the sidebar but has no page body.

Ordering

By default, folders sort before documents, and pages sort by most-recently modified first.

To set an explicit order, add children to a section's index.md:

---
title: Guides
children:
  - deployment
  - authentication
  - troubleshooting
---

Listed pages appear first in order. Any unlisted pages are appended after.

Assets

Non-markdown files (images, PDFs, etc.) placed in the content directory are served in dev and copied to the build output. Reference them with relative paths:

![Diagram](./architecture.png)

Linking between pages

Three ways to link, all resolve the same way:

Wiki links are the fastest to type. Relative .md links have the advantage of working in GitHub's markdown preview and in your editor's go-to-definition.

All internal links are validated — kb build and kb validate will report any broken references.

Frontmatter