Beautiful docs.
Open source. One command.

API reference from your OpenAPI spec. Markdown guides with rich components. One build, static HTML, deploy it yourself.

Get Started Live Demo →

npx sourcey dev

sourcey.com/cheesestore

Features

Batteries included.

Every feature ships in the box. Nothing to install, configure, or pay for separately.

OpenAPI reference

Endpoints, schemas, request/response examples. Auto-generated code samples in cURL, JavaScript, Python, Go, Ruby, Rust, and more.

Markdown guides

Steps, cards, accordions, tabbed code blocks. Rich components in standard markdown alongside your API reference.

TypeScript config

sourcey.config.ts with defineConfig(). Full autocomplete, type checking. One file defines your entire docs site.

Three theme presets

Default sidebar + TOC. Minimal single column. API-first three-column like Stripe. Colors, fonts, and custom CSS on top.

Dark mode

Semantic design tokens, light/dark logo variants, localStorage persistence. Looks great either way.

Vite dev server

SSR hot reload on every component and CSS change. Spec and markdown changes trigger instant refresh.

Instant search

Client-side fuzzy search across all pages and API operations. Cmd+K to find anything. Works offline.

Static HTML output

Zero framework runtime shipped. No vendor lock-in. Deploy to GitHub Pages, Vercel, S3, anywhere.

Configure

Create sourcey.config.ts — define tabs, pages, and theme.

Write

Markdown guides with components. OpenAPI specs for API reference. Or both.

Build

One command. Static HTML. Deploy anywhere.

sourcey.config.ts

import { defineConfig } from "sourcey";

export default defineConfig({
  name: "My API",
  theme: {
    preset: "default",
    colors: { primary: "#6366F1" },
  },
  logo: "./logo.png",
  navigation: {
    tabs: [
      {
        tab: "Documentation",
        groups: [{
          group: "Getting Started",
          pages: ["introduction", "quickstart"],
        }],
      },
      {
        tab: "API Reference",
        openapi: "./openapi.yaml",
      },
    ],
  },
});

Terminal

$ npx sourcey build

sourcey Reading sourcey.config.ts

sourcey Parsing openapi.yaml (42 endpoints)

sourcey Rendering 8 markdown pages

sourcey Generating search index

sourcey Writing static HTML to dist/

done Built in 1.2s — 50 pages, 0 errors

Built in

Built in, not bolted on.

Dark mode, search, and themes work out of the box. No config, no extra dependencies.

Looks great either way.

Semantic design tokens, light and dark logo variants, localStorage persistence. Every component designed for both modes.

My API

Docs API Reference Changelog

Introduction

Welcome to the API documentation. This guide covers authentication, endpoints, and best practices.

$ npm install @myapi/sdk
+ @myapi/[email protected]

Quick Start

GET

POST

DELETE

⌘K

↑↓ navigate ↵ open

Find anything. Instantly.

Client-side fuzzy search across every page and API operation. Cmd+K, start typing. Works offline, no server required.

Three layouts. Your brand.

Pick a preset that fits your docs. Set your colors and fonts. Add custom CSS on top. Ship it.

Default

Minimal

API-first

Comparison

How Sourcey compares.

Your docs shouldn't depend on someone else's SaaS. Same output quality as the tools that charge hundreds monthly. Static HTML, self-hosted, no vendor between you and your users.

	Sourcey	Redocly	GitBook	Mintlify	Fern	VitePress
OpenAPI reference	Native	Native	No	Native	Native	Plugin
Rich components	Yes	No	Limited	Yes	Yes	Vue
Static output	Yes	Yes	No	No	No	Yes
Zero JS shipped	Yes	No	No	No	No	No
Config format	TypeScript	YAML	GUI	JSON	YAML	TypeScript
Dev server	Vite SSR	Webpack	Cloud	Cloud	Cloud	Vite SPA
Self-hosted	Yes	Yes	No	No	No	Yes
Pricing	Free	Freemium	Freemium	Freemium	Paid	Free

Free forever. Own your docs.

AGPL-3.0. Self-host it, fork it, ship it on your own infrastructure. No account required to build your own docs.

View on GitHub npm install sourcey

Beautiful docs. Open source. One command.