Markdown

Docs Ahoy reads CommonMark, the standard Markdown, plus a few extensions.

Text

**bold**, *italic*, ~~struck through~~, `inline code`, ==highlighted==

A [link](https://example.com), and a bare address: https://example.com

Highlights can take a colour: ==done=={color=success} for a background, ==late=={text=warning} for coloured text. The colours are success, warning, danger, info and neutral.

Headings

The # heading at the top is the page's title; use ## and deeper for its sections, without skipping a level. Every heading gets a stable anchor, so you can link to a section and readers can copy its link. Headings also build the "On this page" list.

Lists and quotes

- a bullet
- another one

1. first
2. second

> A quotation.

Task lists (- [ ]), footnotes and emoji shortcodes are not supported: they stay as you typed them.

Tables

| Plan | Libraries |
| --- | ---: |
| Team | many |

Wide tables scroll inside their own box, so the page never scrolls sideways on a phone.

Code

Put code between three backticks and name the language for highlighting:

```ruby
puts "Hello"
```

The language name is shown above the block. Highlighting happens on our server: published pages load no script for it.

HTML is shown as text

HTML in your Markdown is never run as HTML: a tag like <div> shows up literally on the page. That keeps published pages safe and your source portable. To show HTML as an example, put it in backticks or a code block. Everything you would use HTML for has a Markdown form or a block.