Joshua's Cheatsheets-Markdown (MD) tips, notes, and gotchas



  • Some basic HTML is permissable directly in Markdown, which you can use to get around some "gotchas"

    • Some handy ones to remember:

      • <br> for line break
      • &nbsp; for literal non-breaking space
      • &copy; for copyright symbol (©)
    • Note that many converters will strip out certain tags.

    • Of course, if you find yourself writing mostly HTML, it might be time to consider leaving Markdown for your specific file...


  • Linebreaks are often not permissable within certain blocks (like within table row).

    • You can cheat and use <br>, which most MD parsers should echo out as line break.
    • Here is one now:

      === Hey! ===

  • Multiple spaces are truncated, and you can't use spaces for indenting

    • You can always use &nbsp;
    • Bulleted lists are also a good way to inject indenting
  • Subsection (aka anchor) linking:

    • Really good summary from "TomOnTime" that summarize how GitHub handles it:

      1. It downcases the string
      2. remove anything that is not a letter, number, space or hyphen (see the source for how Unicode is handled)
      3. changes any space to a hyphen.
      4. If that is not unique, add "-1", "-2", "-3",... to make it unique
    • Someone made a super easy to use TOC generator based on the above thread; just paste into this webpage.
  • Tables

    • They tend to not get parsed correctly if you don't precede them with either an empty line, or a heading (# My Heading)

Collapsible Sections / block


	<!-- EMPTY LINE -->


	<summary>Click to expand section!</summary>

	This text can be hidden or shown, by clicking the text above!
Click to expand section!
This text can be hidden or shown, by clicking the text above!
Markdown Source Last Updated:
Thu Jan 30 2020 09:03:23 GMT+0000 (Coordinated Universal Time)
Markdown Source Created:
Mon Aug 19 2019 17:06:24 GMT+0000 (Coordinated Universal Time)
© 2020 Joshua Tzucker, Built with Gatsby