StoryLark

Documentation

Everything you need to install, brand, publish, and operate a StoryLark app for standalone stories, complete books, or both.

Start here

Getting Started

Choose the supported publisher path or the advanced engine-contributor path, understand prerequisites, and take the right next step.

Read →

Install

Create a standalone publisher site with npm create storylark. The installer handles dependencies; cloning the engine is reserved for contributors and forks.

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 →

Deploy to Azure

Deploy the same app to App Service, PostgreSQL Flexible Server, and Blob Storage with the included installer and infrastructure template.

Read →

Deployment Safety

Back up, rehearse, compare manifests and narration, prove a no-op second sync, and keep rollback available before changing production.

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

Authoring Stories & Books

Write a single-story Markdown file, a multi-chapter book folder, or both in one library.

Read →

Publishing Stories & Books

Choose among Admin upload, a saved repo connection, GitHub Actions, the CLI pipeline, and the content API.

Read →

Content Pipeline

Publish text, optional narration, word timings, art, and manifests from Markdown with safe incremental updates.

Read →

Voices

Use the bundled free narrator or optional Azure voices, publish multiple narrators, and add preview samples.

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 ↗

Operate

Admin Guide

Manage Stories & Books, narration, themes, connections, updates, accounts, and recovery from the deployed portal.

Read →

Updating

Understand Update now, the always-available installer command, engine history, rollback, and update credentials.

Read →

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 →

Project & reference

Architecture

Understand the engine, Worker, publisher pipeline, storage boundaries, runtime updates, and current free-tier assumptions.

Read →

Roadmap

See what has shipped, what release-1 hardening is active, and what remains before the stable 1.0 contract.

Read →

Release Notes

Read the human-facing notes for the current engine and every earlier preview release.

Read →