Additional Resources¶
Find a HTML, Markdown, and RST comparison chart and links to online cheatsheets here.
Basic Syntax Comparison Chart¶
Use this table as a quick reference for HTML, Markdown [1], and RST.
| Syntax | HTML | Markdown (GFM) | RST |
|---|---|---|---|
| Headings | <H1>YourHeading</H1> for top level heading. <H2>YourHeading</H2> for 2nd level heading, and so on through H6. |
# before your heading. Add more hashtags to designate sub-level headings. You can use up to 6 hashtags, ######, for additional sub-level headings. |
Type your heading. On the line below your heading, type a line of either *, =, or - repeating. The special character line must extend beyond the last letter of your heading. Use a different special character to denote a different level of heading. |
| Bold | <strong>bold</strong> |
**bold** |
**bold** |
| Italics | <em>italics</em> |
*italics* |
*italics* |
| Ordered List |
|
|
|
| Unordered List |
|
|
|
| Image | <image src="source path" alt text= "alt text"> |
 |
.. image:: image path |
| Link | <a href="url">link text</a> |
[In-line text name] (url) |
`link name <url>`_ |
Online Cheatsheets¶
There are a lot of online cheatsheets available. Below are links to just a few. Do your own searches to find the sites/cheatsheets that work best for you.
Markdown cheatsheets:
- https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
- https://help.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax
RST cheatsheets:
- https://sublime-and-sphinx-guide.readthedocs.io/en/latest/index.html
- https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst
Footnotes
| [1] | There are different “flavors” (variations) of Markdown. The syntax used here is for GitHub Flavored Markdown (GFM). |