-
Notifications
You must be signed in to change notification settings - Fork 0
Glossary Markdown cheatsheet
The production definition template provides a skeleton of how to structure a given definition article, and includes some of the Markdown syntax where it's consistent. This includes headers, for example, and anywhere Markdown fails and HTML has to step in.
But you may need to add a few basic things yourself in the course of drafting paragraphs. This will probably not be more than the following fundamentals.
To make text italic, surround it with underscores...
_like this_
To make text bold, surround it with double asterisks...
**like this**
To create a link, put the link text in straight brackets, followed by the URL in parentheses, all together...
[link text](https://domain.tld)
To add a figure, use the same link pattern, but precede it with an exclamation mark, and treat the link text as a figure's alternative text instead (what readers will see if the image path was broken)...

We will not use all of this, but in case you want to expand your horizons, here is the full scope of Markdown supported in the GitHub platform, including in the comments area of Issues (for which there are some useful tips listed), and in this wiki (untested).
Here's a sentence with a reference number.[1]
[1]: And here's the footnote for the reference.
Here's a sentence with a reference number.1 (<sup>1</sup>)
1. And here's the footnote for the reference. (<sup>1.</sup>)
Here's a sentence with a reference number.1 (<a href="#note1" id="note1ref"><sup>1</sup></a>)
1. And here's the footnote for the reference. (<a id="note1" href="#note1ref"><sup>1</sup></a>)
README | Glossary index | Terms register (temporary)