fleet/handbook/marketing/markdown-guide.md

Markdown guide

Headings

Try to stay within three or four heading levels. Complicated documents may use more, but pages with a simpler structure are easier to read.

Markdown	Rendered heading
# Heading 1	Heading 1
## Heading 2	Heading 2
### Heading 3	Heading 3
#### Heading 4	Heading 4

Emphasis

Markdown	Rendered text
**Bold**	Bold
*Italic*	Italic
***Bold italic***	Bold italic
~~Strikethrough~~	Strikethrough

Lists

Ordered lists

Markdown	Rendered list
1. Line one 2. Line two 3. Line three 4. Line four	1. Line one 2. Line two 3. Line three 4. Line four
1. Line one 1. Indent one 2. Line two 3. Line three 1. Indent one 2. Indent two 4. Line four	1. Line one  1. Indent one 2. Line two 3. Line three  1. Indent one  2. Indent two 4. Line four

Unordered lists

Markdown	Rendered list
- Line one - Line two - Line three - Line four	- Line one - Line two - Line three - Line four
- Line one - Indent one - Line two - Line three - Indent one - Indent two - Line four	- Line one  - Indent one - Line two - Line three  - Indent one  - Indent two - Line four

Links

The Fleet website currently supports the following Markdown link types.

Inline link

It's a classic.

Example

[This is an inline link](https://domain.com/example.md)

Rendered output

This is an inline link

Link with a tooltip

Adding a tooltip to your link is a great way to provide additional information.

Example

[This is link with a tooltip](https://domain.com/example.md "You're awesome!")

Rendered output

This is link with a tooltip

URLs

Add angle brackets "< >" around a URL to turn it into a link.

Example

<https://fleetdm.com>

Rendered output

https://fleetdm.com

Emails

To create a mailto link... oh wait, I'm not going to tell you.

Important

: To avoid spam, we NEVER use mailto links.

Tables

To create a table, start with the header by separating rows with pipes (" | "). Use dashes (at least 3) to separate the header, and add colons to align the text in the table columns.

Example

| Category one | Category two | Category three |
|:---|---:|:---:|
| Left alignment | Right alignment | Center Alignment |

Rendered output

Category one	Category two	Category three
Left alignment	Right alignment	Center Alignment

Blockquotes

To add a tip blockquote, start a line with ">" and end the blockquote with a blank newline.

Tip blockquotes

Tip blockquotes are the default blockquote style in our Markdown content.

Example

> This is a tip blockquote.
This line is rendered inside of the tip blockquote.

This line is rendered outside of the tip blockquote.

Rendered output

This is a tip blockquote. This line is rendered inside of the tip blockquote.

This line is rendered outside of the tip blockquote.

Quote blockquotes

To add a quote blockquote, add a <blockquote> HTML element with purpose="quote".

Example

<blockquote purpose="quote">
This is a quote blockquote.

Lines seperated by a blank newline will be rendered on a different line in the blockquote.
</blockquote>

Rendered output

This is a quote blockquote.

Lines seperated by a blank newline will be rendered on a different line in the blockquote.

Large quote blockquote

You can add a large quote blockquote by adding a <blockquote> HTML element with purpose="large-quote".

Example

<blockquote purpose="large-quote"> 
This is a large blockquote.

You can use a large quote blockquote to reduce the font size and line height of the rendered text.
</blockquote>

Rendered output

This is a large blockquote.

You can use a large quote blockquote to reduce the font size and line height of the rendered text.