View on GitHub

Reference

On this page

Overview

This is a reference of all quirks and features specific to our documentation.

Shortcodes

Pre-defined bits of HTML that the user can easily inject into the Markdown.

Alert

{{< alert type="info" >}}
    some content in here
{{<  /alert >}}

type can be any valid Bootstrap alert type. The above produces

Tables

Default Markdown tables don’t come out looking very nice, so we use a shortcode to add Bootstrap classes to them.

Shortcode borrowed from here.

Example:

{{< table “table table-striped table-bordered" >}}
|———-|———-|———-|
| Item 1   | Item 2   | Item 3   |
| Item 1a  | Item 2a  | Item 3a  |
{{< /table */ >}}

Front matter params

Front page favs

highlight: true adds a page to the lists on the home page.

A quick glance at the structure of the yaml file should reveal most of the complexity.

  • divider: true within any group (ie. direct children of the groups list) adds a divider
  • override: /path/to/page changes the path used to search for a page’s permalink when the sidebar is generated. Used on pages like section home page where the slug cannot be changed.

Other tips

Cross references

Use a regular Markdown link but with the relref shortcode as such:

[mail forwarding]({{</* relref "#mail-forwarding" >}})

Syntax highlighting

Fenced code blocks should use triple back ticks ``` and the language always included after the first set of back ticks. A full list of valid languages for special highlighting available here.

Last modified on Tuesday Mar 1, 2022 by Richard Allitt