docholiday

Extensions

Doc-Holiday supports a potentially expandable syntax for extended capabilities.

Extensions are surrounded by triple curly brackets, as in

{{{ }}}

Currently implemented extensions include:

{{{jsdoc tag=“tag name”}}}

The jsdoc extenstion allows us to force a JSDoc tag into a comment block if we really want to use one of the JSDoc tags in our own way. See JSDoc Tags. The tag name given for the tag= property must be within quotes. place any content this tag may require after the extension expression.

{{{plantUML}}}

This allows the following text to be interpreted as PlantUML diagramming directives. See the plantUML page for examples.

{{{text}}}

This simply passes through the following text block as a normal block of text, and by itself is simply a no-op.

This may be used to terminate a {{{plantUML}}} block of text and resume a normal comment text block.