Typography

Welcome to the Typography kitchen sink!

This page contains examples of the different typography options you have available when creating a new documentation page.


Paragraph

Paragraphs can easily be added by just adding the text to the markdown file. Any un-prefixed text will result in a <p> element.


Code references

Inline code references can easily be added like so: <here is some code>


Lists

There are 3 different types of lists available.


Numbered list

To add a numbered list just prefix each list item with a number.

  1. item one
  2. item two
  3. item three

Bullet list

To add a bullet list just prefix each list item with a * or -.

  • item one
  • item two
  • item three
  • item four

Mixed list

If desired you are also able to have mixed lists, a hybrid of a numbered list and bullet list.

  1. step one
    • do this
    • then this
  2. step two
    • do this
    • then this

Headings

We have 3 headings available.


Heading One (H1)

To get a heading one you just need to prefix the heading with #.

Note: Heading 1’s are used to generate the table of contents found on the right-hand side of the page.

If you wish to add a H1 but did not wish for it to be added to the table of contents, you can use the h2 shortcode with the .h1 class applied.

Example:

{{< h2 class="h1" >}}This would be a h1{{< /h2 >}}


Heading Two (H2)

To get a heading two you just need to prefix the heading with ##.

Alternatively, you can use one of the shortcodes with the .h2 class applied.

Example:

{{< h3 class="h2" >}}This would be a h2{{< /h3 >}}


Heading Three (H3)

To get a heading three you just need to prefix the heading with ###.

Alternatively, you can use one of the shortcodes with the .h3 class applied.

Example:

{{< h2 class="h3" >}}This would be a h3{{< /h2 >}}