Cheese Store
A fictional e-commerce API documented end-to-end with Sourcey. Exercises OpenAPI reference, guides, directive components, and the default theme.
Features demonstrated
- OpenAPI 3.1 reference generation
- Markdown guides alongside API reference
- Directive components (tabs, callouts, code groups)
- Client-side search across guides and API operations
- Dark mode with semantic design tokens
- Auto-generated llms.txt and llms-full.txt
The Cheese Store is the default Sourcey showcase. It takes a hand-crafted OpenAPI
spec for a fictional e-commerce API and produces a full documentation site with
zero extra configuration beyond a sourcey.config.ts file.
The example proves three things. A real OpenAPI spec turns into publishable docs in one command. Markdown guides and API reference live in the same site without friction. The default theme does not look like a default theme.
Source
A single openapi.yaml file describing resources, schemas, security, and code
samples. Six markdown guides in a flat directory. One sourcey.config.ts that
wires the two together.
Output
A static HTML site under dist/ with no JavaScript framework shipped to the
browser. Lighthouse scores high across the board. Search works offline. The
generated llms.txt and llms-full.txt let any AI agent consume the docs
without scraping HTML.
Scope
Cheese Store is intentionally fictional. It is not a template for a real API; it is a proof that Sourcey handles the shape of a real API cleanly. For production reference sites, see the other examples.