What is Markdown?

Markdown is a simple way to add a few punctuation marks to text to mark what should be headings, links tables etc. No knowledge of HTML is required. The quick version is:

• start a line with a * to make a bullet point

• start a line with a # to make a heading, sub-headings use two or more hashes to make them smaller

• surround text with an underline _ to make it italics

• surround text in double asterisks ** to make it bold

• to create links put the text in square brackets, followed immediately by the link in brackets: [Google UK] (www.google.co.uk) generates Google UK

• images are links preceded with an !, e.g. ![alt text - used by screen readers and text only browsers](https://www.markdownguide.org/assets/images/tux.png)

• tables are created using - and | to make a table, e.g.

|Column 1|Colum2|
|--------|------|
|First|Row|
|Second|One|

Markdown Cheat Sheet

This guide is taken from the linked website which contains more information on how to use these formats.

Thanks for visiting The Markdown Guide!

This Markdown cheat sheet provides a quick overview of all the Markdown syntax elements. It can’t cover every edge case, so if you need more information about any of these elements, refer to the reference guides for basic syntax and extended syntax.

Basic Syntax

These are the elements outlined in John Gruber’s original design document. All Markdown applications support these elements.

Heading

H1

H2

H3

Bold

bold text

Italic

italicized text

Blockquote

blockquote

Ordered List

1. First item
2. Second item
3. Third item

Unordered List

• First item
• Second item
• Third item

Code

code

Horizontal Rule

Link

Markdown Guide

Image

Extended Syntax

These elements extend the basic syntax by adding additional features. Not all Markdown applications support these elements.

Table

Fenced Code Block

{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}

Footnote

Here’s a sentence with a footnote. ¹

Heading ID

My Great Heading

Definition List

term

definition

Strikethrough

The world is flat.

Task List

• Write the press release
• Update the website
• Contact the media

Emoji Does Not Work

:disappointed:

(See also Copying and Pasting Emoji)

Highlight

I need to highlight these ==very important words==.

Subscript

H2O

Superscript

X^2^

Goat

Ascii-Art drawing convert to SVG:

Looks like you cannot decorate the text, i.e. apply bold or italic within GOAT diagrams.

See (https://github.com/bep/goat/blob/master/README.md)