Quick Start

This walks through a site with Markdown guides and an API reference, running on your machine.

Before you start

• Node.js 22.22.2 or later, 24.15 or later, or 26
• An OpenAPI spec or an MCP server snapshot, if you have one; a site can start with Markdown alone

Create the project

npx sourcey init
npm install
npx sourcey dev

The config

sourcey.config.ts names the site's tabs and the pages each holds. init wrote one; this one adds an API reference:

import { defineConfig, markdown, openapi } from "sourcey";

export default defineConfig({
  name: "My Project",
  theme: {
    colors: { primary: "#0066cc" },
  },
  navigation: {
    tabs: [
      {
        tab: "Documentation",
        slug: "",
        source: markdown({
          groups: [
            { group: "Getting Started", pages: ["introduction", "quickstart"] },
          ],
        }),
      },
      {
        tab: "API Reference",
        slug: "api",
        source: openapi("./openapi.yaml"),
      },
    ],
  },
});

Paths in the config are read from its own folder. See Navigation for tabs, groups and pages.

Write a page

Each page the config lists is a Markdown file of that name: "introduction" is introduction.md.

---
title: Introduction
description: Welcome to our documentation.
---

This is the first page. Write Markdown here.

## Features

- An API reference from the spec
- Guides with components
- Search
- Light and dark appearances

See Writing pages for frontmatter and Components for what pages can use beyond Markdown.

Preview it

npx sourcey dev

The site serves at http://localhost:4400 and redraws what you change as you save it.

Build it

npx sourcey build

Sourcey: building documentation site

  Pages:  4
  Output: /home/me/my-project/dist
  Time:   0.8s

dist/ holds the whole site as static files, with no framework sent to the browser. Publish it on GitHub Pages, Netlify, Vercel, Cloudflare Pages, S3 or any static host; see Deploying.

Next