Markus
Contents

GitHub Flavored Markdown

Every GitHub Flavored Markdown feature Markus renders.

Markus renders CommonMark plus the GFM extensions with markdown-it. Each section shows the Markdown beside what it renders.

Headings

Markus

# Heading 1

## Heading 2

### Heading 3

#### Heading 4

##### Heading 5

###### Heading 6

Preview

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5
Heading 6

Emphasis, strong, strikethrough, inline code

Markus

*Italic*, **bold**, ***both***, ~~struck~~, and `inline code`.

Preview

Italic, bold, both, struck, and inline code.

Markus

An [inline link](https://github.github.com/gfm/), a [link with a title](https://example.com "Example title"), a [reference link][ref], and a bare URL https://github.com/AnthusAI/Markus that becomes a link.

[ref]: https://example.com

Preview

An inline link, a link with a title, a reference link, and a bare URL https://github.com/AnthusAI/Markus that becomes a link.

Images

Markus

![Markus pipeline](../assets/pipeline.svg)

Preview

Markus pipeline

Bullet lists, nested

Markus

- Parse
- Validate
  - Attributes
  - Nesting
- Render

Preview

  • Parse
  • Validate
    • Attributes
    • Nesting
  • Render

Ordered lists

Markus

1. Parse
2. Validate
3. Render

Starting elsewhere:

5. Five
6. Six

Preview

  1. Parse
  2. Validate
  3. Render

Starting elsewhere:

  1. Five
  2. Six

Task lists

Markus

- [x] Tables
- [x] Strikethrough
- [ ] Something still to do

Preview

  • Tables
  • Strikethrough
  • Something still to do

Tables with alignment

Markus

| Left | Center | Right |
| :--- | :---: | ---: |
| a | b | c |
| longer | cell | 12 |

Preview

Left Center Right
a b c
longer cell 12

Fenced code with a language

Markus

```python
from markusmd import convert

html = convert("# Hello\n")
```

Preview

from markusmd import convert

html = convert("# Hello\n")

Indented code

Markus

    four spaces
    make a code block

Preview

four spaces
make a code block

Blockquotes

Markus

> A quote.
>
> > A nested quote.

Preview

A quote.

A nested quote.

GFM alerts

Markus

> [!NOTE]
> A note alert.

> [!WARNING]
> A warning alert.

Preview

Note

A note alert.

Warning

A warning alert.

Thematic break

Markus

Above

---

Below

Preview

Above

Below

Hard and soft line breaks

Markus

A soft break
continues the line.

A hard break ends with two spaces  
or a backslash\
and starts a new line.

Preview

A soft break continues the line.

A hard break ends with two spaces
or a backslash
and starts a new line.

Typographer

Markus

"Smart quotes", it's, an ellipsis..., and a dash -- or --- are typeset.

Preview

"Smart quotes", it's, an ellipsis..., and a dash -- or --- are typeset.

Escapes

Markus

\*not italic\*, \`not code\`, and \# not a heading.

Preview

*not italic*, `not code`, and # not a heading.

Raw HTML

Raw HTML is off unless you pass --allow-html. This site does not enable it, so an HTML tag in source is shown as text:

<kbd>Ctrl</kbd>