Typography

1. Headings

Markdown syntax denotes headers starting with between 1 to 6 #.

Markdown:

### Heading Level 3 

Rendered Output:

2. Thematic breaks

You can create a thematic break, to break content between themes, using three or more *, -, or _ characters on a line by themselves.

Markdown:

* * *

Rendered Output:

3. Inline Text Formatting

Standard inline formatting including bold, italic, code, as well as escaped symbols and line breaks:

Markdown:

**strong**, _emphasis_, `literal text`, \*escaped symbols\*

Rendered Output:

strong, emphasis, literaltext, *escaped symbols*

The strikethrough extension allows you to add strike-through text:

Markdown:

~~strikethrough with *emphasis*~~

Rendered Output:

strikethrough with emphasis

The smartquotes and replacements extensions can improve the typography of common symbols:

Markdown:

Smart-quotes 'single quotes' and "double quotes".

+-, --, ---, ... and other replacements.

Rendered Output:

Smart-quotes ‘single quotes’ and “double quotes”.

+-, –, —, … and other replacements.

4. Line Breaks

To put a line break, without a paragraph, use a \ followed by a new line. This corresponds to a <br> in HTML and \\ in LaTeX.

Markdown:

**u-blox** \
offers a wide range of high-quality,\
scalable, and secure cellular modules.

Rendered Output:

u-blox
offers a wide range of high-quality,
scalable, and secure cellular modules.

5. Bullet points and numbered lists

You can use bullet points and numbered lists as you would in standard Markdown. Starting a line with either a - or * for a bullet point, and 1. for numbered lists. These lists can be nested using two spaces at the start of the line.

Markdown:

- Lists can start with `-` or `*`
  * My other, nested
  * bullet point list!

1. My numbered list
2. has two points

Rendered Output:

• Lists can start with - or *

  • My other, nested

  • bullet point list!

1. My numbered list

2. has two points

For numbered lists, you can start following lines with any number, meaning they don’t have to be in numerical order, and this will not change the rendered output. The exception is the first number, which if it is not 1. this will change the start number of the list.

6. Subscript & Superscript

For inline typography for subscript and superscript formatting, the sub and sup {{role}}, can be used respectively.

Markdown:

H{sub}`2`O, and 4{sup}`th` of July

Rendered Output:

H₂O, and 4^th of July

7. Quotations

Quotations are controlled with standard Markdown syntax, by inserting a caret (>) symbol in front of one or more lines of text.

Markdown:

> We know what we are, but know not what we may be.

Rendered Output:

We know what we are, but know not what we may be.

8. Comments

You may add comments by putting the % character at the beginning of a line. This will prevent the line from being parsed into the output document.

For example, this won’t be parsed into the document:

Markdown:

% my comment

Rendered Output:

a line
% a comment
another line

9. Footnotes

Footnotes use the pandoc specification. Their labels start with ^ and can then be any alphanumeric string (no spaces), which is case-insensitive.

• If the label is an integer, then it will always use that integer for the rendered label (i.e. they are manually numbered).

• For any other labels, they will be auto-numbered in the order which they are referenced, skipping any manually numbered labels.

All footnote definitions are collected, and displayed at the bottom of the page (in the order they are referenced). Note that un-referenced footnote definitions will not be displayed.

Markdown:

- This is a manually-numbered footnote reference.[^3]
- This is an auto-numbered footnote reference.[^myref]

[^myref]: This is an auto-numbered footnote definition.
[^3]: This is a manually-numbered footnote definition.

Rendered Output:

• This is a manually-numbered footnote reference.[3]

• This is an auto-numbered footnote reference.[1]

Any preceding text after a footnote definitions, which is indented by four or more spaces, will also be included in the footnote definition, and the text is rendered as MyST Markdown, e.g.

Markdown:

A longer footnote definition.[^mylongdef]

[^mylongdef]: This is the _**footnote definition**_.

    That continues for all indented lines

    - even other block elements

    Plus any preceding unindented lines,
that are not separated by a blank line

This is not part of the footnote.

Rendered Output:

A longer footnote definition.[2]

This is not part of the footnote.

By default, the footnotes will be collected, sorted and moved to the end of the document, with a transition line placed before any footnotes (that has a footnotes class).