docs: font support in compose and caption.burn - #74
Merged
Conversation
compose's text-style reference listed seven bundled families as the whole of `style.font`. It now takes any Google Fonts family by name, a CSS fallback stack, and families declared from your own files via the `fonts` input, so the row was wrong rather than merely incomplete. Adds a Fonts section to compose covering all of it: Google by name, the `fonts` array with caller-chosen family names, the `font` shorthand, fallback stacks as a failure policy with the `fontFallbacks` report, weights, and script coverage. caption.burn resolves Google families by name through the same code, which its `fontFamily` field did not say, and its `font` input was undocumented altogether. captions.animate does NOT share that resolver. It stages a supplied file for libass on its own path and never reaches the catalogue, so its section now says so outright instead of leaving a reader to assume the sibling job's behaviour.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents the font work shipped in rendobar/rendobar #570 through #575, now live in prod.
compose
The text-style reference said
fontwas one of seven bundled families. That is now wrong, not just incomplete: it takes any Google Fonts family by name, a CSS fallback stack, and families declared from your own files.New
## Fontssection covers Google-by-name, thefontsarray with caller-chosen family names, thefontshorthand, fallback stacks as a failure policy (with thefontFallbacksreport shape), weights, and script coverage.caption.burn
Resolves Google families by name through the same
stageFontscode, whichfontFamilydid not say. Itsfontinput was undocumented altogether.Verified in prod, not inferred:
job_e673dcd8c7d247d0withfontFamily: "Bebas Neue"and no font file renders in Bebas Neue.captions.animate
Deliberately not given the same claim. It stages a supplied file for libass on its own path in
detect.tsand never reaches the font catalogue, so Google-by-name does not work there. A<Note>says so and points at the two jobs where it does, rather than leaving a reader to assume the sibling job's behaviour.That inconsistency is real and worth closing in the API, but it is a change to a working captions path, so it is not smuggled into a docs PR.