Markdown

Clay reads GitHub Flavored Markdown, the Markdown you know from READMEs and issues on GitHub. This page shows each element with its source and result.

#Headings

## A section
### A subsection

# is the page heading; use it once per page. ## and ### headings appear in the table of contents and become search results of their own. Every heading gets an anchor, built like GitHub builds them, so you can link to a section: the heading “Line breaks” below is reachable as #line-breaks. Hover a section heading, and a # link to it appears on its left, ready to copy.

#Emphasis

**bold**, *italic*, ~~strikethrough~~ and `inline code`

bold, italic, strikethrough and inline code

#Line breaks

A line break in your text is a line break on the page, like in GitHub comments. Separate paragraphs with an empty line.

First line
second line, in the same paragraph

A new paragraph

First line
second line, in the same paragraph

A new paragraph

#Lists

- Coffee
- Tea
  - Green tea
  - Black tea

1. Install
2. Configure
3. Build

• Coffee
• Tea
  • Green tea
  • Black tea

1. Install
2. Configure
3. Build

#Task lists

- [x] Write the docs
- [x] Build the site
- [ ] Publish it

• Write the docs
• Build the site
• Publish it

#Tables

Columns can be aligned left, centered or right with colons in the separator line:

| Command | Port | Purpose |
|:--------|:----:|--------:|
| dev     | 3000 | write   |
| preview | 4173 | check   |

#Quotes

> Documentation is a love letter that you write to your future self.

Documentation is a love letter that you write to your future self.

A quote that starts with [!NOTE], [!TIP] and similar becomes an alert.

#Horizontal rules

Three hyphens on their own line draw a line across the page:

---

#Links, images and code

These have pages of their own:

• Links and images: links between pages, images and downloads.
• Code blocks: syntax highlighting, highlighted lines and diffs.
• Alerts: notes, tips and warnings.
• HTML: HTML inside Markdown and what Clay removes from it.