Skip to main content

Supported Markdown

To get started with Markdown, see the CommonMark Reference.

Specifications

GuideME is based on the micromark Markdown parser, which supports:

Inline Formatting

MarkdownAlternativeResult
*Italic*_Italic_italic
**Bold**__Bold__bold
~~Strikethrough~~~Strikethrough~strikethrough
[Link](http://a.com)link
[Link](./index.md)link
[Link](testmod:index.md)link
`Inline Code`inline code
![Image](test.png)image

Headings

Headings can be defined by prefixing them with #.

# Heading 1

## Heading 2

### Heading 3

#### Heading 4

##### Heading 5

###### Heading 6

Result:

headings

Other Block Elements

Horizontal Rule:

Markdown:

---

Result:

horizontal rule

Markdown:

> Blockquote

Result:

horizontal rule

Lists

Markdown:

- List
- List
- List

1. One
2. Two
3. Three

Result:

lists

Tables

Markdown:

| First Header  | Second Header |
| ------------- | ------------- |
| Content Cell | Content Cell |
| Content Cell | Content Cell |

Result:

table