Markdown guide for the handbook

[mike-j-thomas]

Markdown guide for the handbook.

[mike-j-thomas]

Created this draft PR for 2nd level handbook content with @Desmi-Dizney.

• Des to update titles, and then v1 is ready to merge.

Ignore this review, sry, just testing the bot.

Sweet it works now. You should get auto-unfrozen

[mike-j-thomas]

@Desmi-Dizney, please can you address the following changes:

• Change "Markdown option one" to "Markdown" since we are not including alt versions

• Check the table column headings for correct sentence casing

• Remove HTML cols from the example tables. Let's keep it simple and only show Markdown and Rendered output.

• In the Emphasis section, please remove the row for underlining text. Markdown does not support underlining text, and underlining with HTML is not recommended as this is reserved for hyperlinks

• In the Unordered list section, add an h3 for "Nesting unordered lists" above the nesting info

• In the same section, add an h4 "Example" above your Markdown examples. Then add an h4 "Rendered output" in place of "This renders as"

• The Links section is hard to read when it's rendered on the site. Let's break that section up into the following, using h3 tags for each subsection:

  • Inline link
  • Inline link with a tooltip
  • Relative link
  • URLs and email addresses

• Here is an example of how to organize the subsections listed above:

Start of Mike T's example

Inline link

Example

[This is an inline link](https://fleetdm.com/handbook/digital-experience/markdown-guide.md)

Rendered output

This is an inline link

End of Mike T's example

• "Type command + K for a simple link template." Unless I'm mistaken, I'm pretty sure that this only works in certain software, e.g. GitHub. Please add this as a Note. Something like:

Tip: In GitHub, you can highlight the text that you want to add a link to and hit command + K

• Mailto section. Remove this section. Note that I suggested consolidating this under Links "URLs and email. Remember to move the note about never using mailto links before you delete it.
• Add an h2 "Tables" and follow the same format mentioned previously. I.e., h4 "Example" followed by h4 "Rendered output."

[mike-j-thomas]

Hey @Desmi-Dizney, I have a couple of tasks that I needed to push live that point to this guide, so I actioned my previous review feedback. I also solved how to render nested lists within a table. You can check it out in the Files changed tab if you're interested in how to do that for future reference.