Shortcodes

A bunch of Shortcodes are available with this theme :

    alert

    The alert shortcode allows you to highlight information in your page.

    attachments

    The Attachments shortcode displays a list of files attached to a page.

    button

    Display an actionable button in your page.

    children

    List the child pages of a page

    excerpt

    The Excerpt shortcode is used to mark a part of a page's content for re-use.

    excerpt-include

    The Excerpt Include shortcode is used to display ‘excerpted’ (that is, a segment of) content from one page in another. Before you can use this shortcode, the excerpt must have been defined using the Excerpt shortcode. Note that you can have more than one Excerpt Include shortcode on a page (although you can have only one Excerpt shortcode on a page). Usage Parameter Default Description filename required Type the filename of the page that contains the excerpt to be displayed.

    expand

    Displays an expandable/collapsible section of text on your page

    icon

    Display an icon.

    mermaid

    Flowchart example Show code ... {{<mermaid align="left">}} graph LR; A[Hard edge] -->|Link text| B(Round edge) B --> C{Decision} C -->|One| D[Result one] C -->|Two| E[Result two] {{< /mermaid >}} mermaid.initialize({startOnLoad:true}); graph LR; A[Hard edge] --|Link text| B(Round edge) B -- C{Decision} C --|One| D[Result one] C --|Two| E[Result two] Sequence example Show code ... {{<mermaid>}} sequenceDiagram participant Alice participant Bob Alice->>John: Hello John, how are you?

    notice

    Disclaimers to help you structure your page

    panel

    Allow you to highlight information or put it in a box.

    platforms

    Lists available platforms

    revealjs

    present content as a reveal.js slide