glue-js-documentation-builder v3.35.6

Commands

Custom HTML tags

The documentation generator supports the custom <glue42> tag with the following templates:

Template for inserting two "before/after" images compared with a slider

<glue42 name="slider" top="../../relative-path-to-image.png" bottom="../../relative-path-to-image.png">

Template for inserting custom class and text in a specified HTML element.

<glue42 name="addClass" element="p" class="custom-class" text="Welcome!">

Reference

glue-js-documentation-builder build-reference --project g4e --destinationPath <destinationPath>

Supported tags

• @intro markdown - the intro of each API
• @docname string- the name will be used in the documentation
• @docmenuorder number - it will be used for the ordering
• @ignore - to not be displayed in the documentation
• @example - markdown example - should be like the markdown

Supported placeholders for the @intro tag

• {GLUE_VER} - will be replaced with current version

Changelog