Reference
At a glance
Section titled “At a glance”Use this section as the entry point for reference material: API inventories, configuration keys, compatibility tables, supported CSS behavior, and cross-package coverage ledgers.
Reference map
Section titled “Reference map”| Reference | What it answers |
|---|---|
| CSS support matrix | Which CSS features the HTML pipeline verifies, claims, partially supports, or does not support. |
| Integrations API index | Which extension API page covers each framework, renderer, transport, and build-tool surface. |
| Integration sections | Where to find package-specific API and configuration reference. |
| Core module reference | Module-level API and architecture pages generated from the core repository. |
Reference entry contract
Section titled “Reference entry contract”Every API entry must answer the same questions:
| Question | Required answer |
|---|---|
| What do I call? | Fully qualified symbol, endpoint, command-line interface (CLI) command, or config key. |
| What input is accepted? | Parameter table with type, required status, default, and accepted values. |
| What happens by default? | The behavior when optional input is omitted. |
| What comes back? | Return type, response body, file output, stream, or side effect. |
| What can fail? | Exception, validation error, HTTP status, or operational failure mode. |
| How do I use it safely? | Security, worker-safety, size-limit, path, timeout, and secret-handling notes. |
Coverage policy
Section titled “Coverage policy”Reference pages are source-backed. Public APIs are documented from package source, config files, tests, and examples. Internal helper classes are documented only when application developers must understand their behavior to configure or operate the package.
Translation readiness
Section titled “Translation readiness”Reference pages prefer tables over dense paragraphs. Each row should stand on its own, because later Extensible Localization Interchange File Format (XLIFF) segmentation will split content by block.