User guide
User guide
Authoritative behavior for configuring, authoring, building, and deploying a Syncpress site.
The user guide defines the current observable authoring, command-line, and programmatic contract. Begin with Build a Syncpress site for one guided lifecycle.
Project and authoring
- Configuration defines
site.yaml, defaults, paths, Markdown policy, image policy, collections, and deployment settings. - Content, front matter, and routes defines page admission, page data, publication controls, canonical addresses, and output ownership.
- Liquid templates and page data defines evaluation order, context values, includes, escaping, and unsupported constructs.
- Collections and excerpts defines selection, filtering, card shape, ordering, and excerpt conversion.
- References, assets, and responsive images defines scanned URL locations, local copying, public files, and raster processing.
Running and deploying
Commands, deployment, and diagnostics defines strict builds, watch mode, the development server, inspection, generated artifacts, failure reporting, and reconciliation limits.
Programmatic API defines the package-root functions, result types, callbacks, and resource cleanup.
Implementation documentation
The preceding pages define the site-authoring contract. The following pages document repository implementation for contributors.
How Syncpress is built explains the design boundaries, batch model, transactions, and publication gate. Selected composition paths traces representative routing, rendering, diagnostic, deployment, and reconciliation reactions.