Skip to content

Glossary Markdown cheatsheet

Dᴼᴷᵀᴼᴿ D. ᵂᵁᴺᴰᴵᴮᴬR edited this page Mar 14, 2017 · 7 revisions

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.

Fundamental Markdown used

Italic text

To make text italic, surround it with underscores...
_like this_

Bold text

To make text bold, surround it with double asterisks...
**like this**

Links

To create a link, put the link text in straight brackets, followed by the URL in parentheses, all together...
[link text](https://domain.tld)

Figures

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)...
![Alt text](https://domain.tld/path/to/image.png)

All Markdown supported in GitHub

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).

Experiments (just ignore)

Footnotes test 1: No superscripts

Here's a sentence with a reference number.[1]

[1]: And here's the footnote for the reference.

Footnotes test 2: Superscripts but no links

Here's a sentence with a reference number.1 (<sup>1</sup>)

1. And here's the footnote for the reference. (<sup>1.</sup>)

Footnotes test 3: Super scripts and links

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>)

Clone this wiki locally