Documentation
¶
Overview ¶
Package main generates one document per mermaid subpackage, every label of which holds the punctuation that means something to mermaid.
The other generators under doc/ are documentation: they are quoted in the README and they have to stay readable. That makes them poor tests, because the labels a reader wants to see are exactly the ones that never break a renderer. The labels here are the opposite, and the documents they produce are rendered in continuous integration alongside the others, so a quoting defect fails the build rather than reaching a user's diagram.
One document per diagram type, rather than one document holding all of them, so that a failing render names the subpackage that produced it instead of a line number that moves whenever a label changes.
Source Files