How To Markdown - AlexisBliesener/Bewitched GitHub Wiki

Markdown Guide

Markdown is a lightweight markup language used to format text. This guide covers the basics of how to use it.

Table of Contents

  1. Markdown Editor
  2. Headings
  3. Emphasis
  4. Lists
  5. Links
  6. Images
  7. Horizontal Rules
  8. Tables

Markdown Editor

If you find it easier to see what your markdown syntax is turning into while typing it I recommend using this web based markdown editor

Headings

Use # for headings. Add more # symbols for smaller headings.

# H1
## H2
### H3
#### H4
##### H5
###### H6

Output:

H1

H2

H3

H4

H5
H6

Emphasis

You can emphasize text in Markdown using asterisks * or underscores _.

Italic

*Italic*  
_Italic_
**Bold**  
__Bold__
~~Strikethrough~~

Output: Italic Italic Bold Bold Strikethrough

Lists

Markdown supports both unordered and ordered lists.

Unordered List

Use dashes -, plus signs +, or asterisks * for unordered lists.

- Item 1
- Item 2
  - Subitem 2.1
  - Subitem 2.2
* Item 3
+ Item 4

Output:

  • Item 1
  • Item 2
    • Subitem 2.1
    • Subitem 2.2
  • Item 3
  • Item 4

Ordered List

Use numbers followed by periods.

1. First
2. Second
   1. Sub-second
   2. Sub-third
3. Third

Output:

  1. First
  2. Second
    1. Sub-second
    2. Sub-third
  3. Third

Links

You can add hyperlinks using square brackets [] for the text and parentheses () for the URL.

Basic Link

To any website

[WatersBears Wiki Page](https://en.wikipedia.org/wiki/Tardigrade)

Output: WatersBears Wiki Page

Reference-style Links

To any of our wiki pages just use the wiki page name as the URL

[Design Pillars Wiki Page](Design-Pillars)

Output: Design Pillars Wiki Page

Images

Images in Markdown use the same syntax as links, but with an exclamation mark ! in front.

Basic Image

![Alt text](https://via.placeholder.com/150)

Output: Alt text

Horizontal Rules

You can create horizontal rules (lines) using three or more dashes ---, asterisks ***, or underscores ___ on a line by themselves.

---
***
___

Output:

Tables

You can create tables using pipes | and dashes -. The header row is separated from the rest of the table by dashes. You can align columns by adding colons :.

Basic Table

| Left Align | Center Align | Right Align |
|:-----------|:------------:|------------:|
| Text       | Text         | Text        |
| More text  | More text    | More text   |

Output:

Left Align Center Align Right Align
Text Text Text
More text More text More text