Sourcey

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 init
sourcey.com/cheesestore
How it works

Config. Write. Ship.

One TypeScript config, your content, one command. No accounts, no dashboards, no build pipelines to assemble.

01

Configure

Define your entire docs site in a single TypeScript file. Tabs, pages, theme, logo — all type-checked with full autocomplete.

sourcey.config.ts 
import { defineConfig } from "sourcey";

export default defineConfig({
  name: "My API",
  theme: {
    preset: "default",
    colors: { primary: "#6366F1" },
  },
  navigation: {
    tabs: [
      {
        tab: "Documentation",
        groups: [{
          group: "Getting Started",
          pages: ["introduction", "quickstart"],
        }],
      },
      ...
    ],
  },
});
authentication.md 
# Authentication

Keys are scoped to **read**, **write**, or **admin**.
Rotate them under Settings → API Keys. Revoked
keys return `401` immediately.

<CardGroup cols={2}>
  <Card title="REST API" icon="book" href="/api">
    Full endpoint reference
  </Card>
  <Card title="Webhooks" icon="zap" href="/webhooks">
    Event payloads and retry logic
  </Card>
</CardGroup>
02

Write

Standard markdown with rich components when you need them — cards, steps, accordions, tabbed code blocks. Your OpenAPI spec renders as full API reference with code samples in 10 languages.

Guides and API reference share the same design, the same navigation, the same build. One tool, one output.

03

Build

One command. Static HTML with zero JavaScript framework runtime. Every page is a real HTML file that loads instantly and works without client-side rendering.

Deploy to GitHub Pages, Vercel, Netlify, S3, or your own server. No vendor dependency. Your docs survive even if we don't.

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
npx sourcey init Docs →
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.

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
Search...
Docs API Reference Changelog
Getting Started
Introduction
Quick Start
Authentication
Concepts
Webhooks
Directives
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.

docs.example.com
Getting Started
API
GET
POST
DEL
Endpoints
GET
POST
PUT
DEL
GET
cURL
JavaScript
Python
Response
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
Sourcey

Free forever. Own your docs.

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

View on GitHub npx sourcey init