StoryLark

Documentation

Everything you need to stand up, brand, and publish your own StoryLark app. Start with the basics, then customize.

Start here

Getting Started

Clone, install, and run the engine locally under the neutral base brand — dev, build, typecheck, and how brand "mode" works.

Read →

Deploy Your Own

Stand up your own site on Cloudflare: create a brand, configure Wrangler, provision D1 + R2, set secrets, deploy, and publish.

Read →

Customize

Build Your Own Theme

The branding layer: the full theme.css token contract (light + dark), every brand.json field, fonts, and icons.

Read →

Build Your Own Presentation

The structure layer: what's configurable today (layout, nouns), the app shell, and where presentation templates are headed.

Read →

Content

Content Pipeline

Publish stories: source → chapter JSON + neural-TTS audio + word timings → R2 → manifest. The parser contract, flags, incremental hashing, and local mode.

Read →

Reference & design docs

Architecture, API reference, data model, auth, web push, PWA/offline, and read-along — the deeper technical docs live with the source.

Browse on GitHub ↗

Standards

Content Format (SCF v1)

The normative content contract: the storylark: frontmatter block, its fields, ids, ordering, and the full stable error-code vocabulary.

Read →

Content API Standard

What a publisher's system — CMS, release pipeline, or script — can rely on: versioning, auth, ownership, and the error contract.

Read →

Repo Connection Standard

What a connectable git repository looks like: providers, triggers, deletion policy, and prerequisites.

Read →

Deployment Requirements

What any platform must provide for StoryLark to run on it, with both live deployments measured against the checklist.

Read →