Skip to Content
KTB Health Docs
Tutorials

Getting started

Set up the docs site locally and understand the layout.

This tutorial takes you from a fresh clone to a running docs site.

Prerequisites

  • Bun (the repo's package manager)
  • Git

Steps

  1. Clone the repository and install dependencies:

    git clone https://github.com/ktbhealth/docs.git
    cd docs
    bun install

    bunfig.toml sets linker = "hoisted" — keep it. Bun's default isolated linker breaks the nitro dev server.

  2. Start the dev server:

    bun run dev

    The site is served at http://localhost:3000. Documentation pages live under /<locale>/docs (e.g. /en/docs).

  3. Open content/docs/en/index.mdx and edit it. The dev server hot-reloads MDX content.

Verify

  • Visit http://localhost:3000/en/docs and confirm your edit appears.
  • Run bun run types:check to typecheck without emitting.

On this page