cbc4565b57
* 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>
3.1 KiB
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~~ |
Lists
Ordered lists
| Markdown | Rendered list |
|---|---|
1. Line one |
1. Line one 2. Line two 3. Line three 4. Line four |
1. Line one |
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 one - Line two - Line three - Line four |
- Line one |
- 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
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
URLs
Add angle brackets "< >" around a URL to turn it into a link.
Example
<https://fleetdm.com>
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 |