From cbc4565b574c80e2a0b9d8e6fe3fc8daa329d251 Mon Sep 17 00:00:00 2001 From: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com> Date: Thu, 4 Aug 2022 11:45:44 +0900 Subject: [PATCH] Markdown guide for the handbook (#6864) * Markdown guide for the handbook Markdown guide for the handbook. * Update markdown-guide.md * Update markdown-guide.md * Update markdown-guide.md * Update markdown-guide.md * Update markdown-guide.md * Update handbook/digital-experience/README.md * Update handbook/digital-experience/markdown-guide.md * Handbook - Re-ordered Digital Experience README.md - I repositioned Markdown to be under Voice and tone. @Desmi-Dizney, I think you are right. Including the Markdown section under the section for writers is better. * Update markdown-guide.md - actioned review comments (https://github.com/fleetdm/fleet/pull/6864#pullrequestreview-1053545929) - reformatted the markdown guide. - updated nested list examples to display inside a table - removed a couple of link examples that don't currently render on the website * Update README.md - I removed the Markdown section. I'd prefer to link to this guide as and when it's needed. Co-authored-by: Desmi-Dizney <99777687+Desmi-Dizney@users.noreply.github.com> --- handbook/digital-experience/markdown-guide.md | 105 ++++++++++++++++++ 1 file changed, 105 insertions(+) create mode 100644 handbook/digital-experience/markdown-guide.md diff --git a/handbook/digital-experience/markdown-guide.md b/handbook/digital-experience/markdown-guide.md new file mode 100644 index 0000000000..d0570dad6f --- /dev/null +++ b/handbook/digital-experience/markdown-guide.md @@ -0,0 +1,105 @@ +# 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](https://domain.com/example.md) + +### 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](https://domain.com/example.md "You're awesome!") + +### URLs + +Add angle brackets "< >" around a URL to turn it into a link. + +#### Example + +`` + +#### Rendered output + + + +### 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 | + + + \ No newline at end of file