Repository navigation
Draw four docs diagrams with Mermaid, and stop splitting code names - #384
Merged
Merged
Conversation
The docs site renders ```mermaid blocks as diagrams; the theme loads Mermaid only on a page that has one. Four pages get one: Color spaces shows the tree every conversion climbs through, Architecture replaces its text sketch of an edit with a flowchart, Color pickers shows a controlled picker's round trip through the caller, and State management shows a grey keeping its hue. The theme let inline code break at any character, so a narrow table column split names a reader copies (HsvColorPick-er, colorpicker-material3 at its hyphen). Code in a table now stays on one line and the table scrolls sideways; code in running text breaks at its spaces, and inside a name only when the name alone is wider than the line. The llms.txt script reads mkdocs.yml with a loader that keeps the superfences hook reference as text, since the safe loader rejects that tag.
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
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.
Four diagrams on the docs site, and inline code that no longer splits mid-name.
Diagrams (Mermaid, which the theme loads only on a page that has one):
Code wrapping: the theme let inline code break at any character, so narrow table columns split names such as
HsvColorPickerandcolorpicker-material3. Code in a table now stays on one line and the table scrolls sideways; code in running text breaks at its spaces, and inside a name only when the name alone is wider than the line.llms.txt: the script reads
mkdocs.ymlwith a loader that keeps the superfences hook reference as text, since the safe loader rejects that tag.Checked locally:
zensical build --strictpasses, the llms.txt step runs, and every diagram parses with the page's own Mermaid. Text measured in the browser at 2560 px and 390 px: no code name splits inside a table at either width.