Nearly all Markdown applications support the basic syntax outlined in the original Markdown design document. There are minor variations and discrepancies between Markdown processors — those are noted inline wherever possible.
To create a heading, add number signs (
#) in front of a word or phrase. The number of number signs you use should correspond to the heading level. For example, to create a heading level three (
<h3>), use three number signs (e.g.,
### My Header).
Alternatively, on the line below the text, add any number of
== characters for heading level 1 or
-- characters for heading level 2.
Heading Best Practices
Markdown applications don’t agree on how to handle a missing space between the number signs (
#) and the heading name. For compatibility, always put a space between the number signs and the heading name.
You should also put blank lines before and after a heading for compatibility.
# Heading<br><br> ...and after a heading. </code> </td> <td> <code class="highlighter-rouge"> Without blank lines, this might not look right.<br> # Heading<br> Don't do this! </code> </td> </tr>