Documentation
Using and running it
| Page | What it covers |
|---|---|
| Metadata | the Metadata Block a Document author writes: syntax, layering, field types, errors |
| Binding | the block a Collection admin uses to choose a Template and Configuration |
| Images | images and logos: formats, sizes, captions, limits, errors |
| Deploying with Docker Compose | running Gateway and Worker with Docker Compose |
| Injector and download button | the reverse proxy that adds the Download PDF button |
| Limits and admission control | limits and admission control |
Writing Templates
| Page | What it covers |
|---|---|
| Template author guide | start here: package format, fields, patterns, deny-list, validate, render, goldens, a worked example |
| Packages | reference for packages, field types, typed patterns, TeX deny-list, drift guard |
| Standard Fields | the Standard Fields |
How it works
| Page | What it covers |
|---|---|
| Architecture | Gateway and Worker roles, the job bundle, request flow, error mapping |
| Worker pipeline | the Worker pipeline, filters, engine lockdown |
| Security | the security layers and what each proves |
| Architecture decision records | architecture decision records |
| Vocabulary | the vocabulary |
Developing and publishing
| Page | What it covers |
|---|---|
| Development stack and end-to-end tests | the seeded local stack with Outline |
| Testing | test tiers and CI |
| Sanitisation gate | the sanitisation gate and the pre-publish audit |
| Publishing checklist | the maintainer's checklist before the repository goes public |
| Releasing | the maintainer's release procedure: release PR, image publishing, one-time settings |
| Research notes | the research notes behind the design |
| Third-party notices | third-party licences and the Pandoc source offer |