On this page
Markdown
Clay reads Clay Flavored Markdown (CFM): GitHub Flavored Markdown, the Markdown you know from READMEs and issues on GitHub, plus alerts, components, math and diagrams. Everything GitHub shows works in Clay too, and what Clay adds stays readable on GitHub. Each element below shows its result and its source; pick Markdown once to see the source everywhere.
#Headings
## A section
### A subsection# is the page heading; use it once per page. ## and ### headings appear in the contents of the page 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 paragraphTip
Keep each paragraph on one line in your editor and let it wrap the text. Hard-wrapped paragraphs show their line breaks on the page.
#Lists
- Coffee
- Tea
- Green tea
- Black tea
- Install
- Configure
- Build
- Coffee
- Tea
- Green tea
- Black tea
1. Install
2. Configure
3. BuildFor instructions in order, steps show a numbered list as a guide.
#Task lists
- [x] Write the docs
- [x] 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 |
| 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:
---