Writing with Markdown

Markdown is a simple way to format text that works everywhere on our platform. Instead of
clicking formatting buttons, you type simple symbols that get converted to formatted text.

Why Use Markdown?

  • Fast: Type formatting without leaving your keyboard
  • Universal: Works on product descriptions, messages, events, and more
  • Portable: Copy text to other platforms and it still works
  • Clean: No hidden formatting codes that cause issues

Basic Formatting

Bold and Italic

What You Type What You Get
**bold text** bold text
*italic text* italic text
***bold and italic*** bold and italic
~~strikethrough~~ ~~strikethrough~~

Headings

Use hash symbols (#) at the start of a line:

# Large Heading
## Medium Heading
### Small Heading
#### Smaller Heading

Lists

Bullet Lists

Type an asterisk, plus, or dash before each item:

* First item
* Second item
* Third item

Numbered Lists

Type a number and period before each item:

1. First step
2. Second step
3. Third step

Task Lists

Create checkboxes with square brackets:

- [ ] Unchecked task
- [x] Completed task

Links and Images

Creating Links

[Click here to learn more](https://example.com)

Becomes: Click here to learn more

Adding Images

![Product photo](https://example.com/image.jpg)

The text in square brackets is the alt text (description) for accessibility.

Quotes and Code

Block Quotes

Start a line with > for quotes:

> This is a quote from a customer review.
> It can span multiple lines.

> This is a quote from a customer review.

Code

Use backticks for inline code like variable names.

Use triple backticks for code blocks:

```
function example() {
  return true;
}
```

Horizontal Rules

Create a divider line with three dashes:

---

Using the Editor

Our Markdown editor includes a toolbar with buttons for common formatting:

Icon Action
B Bold
I Italic
~~S~~ Strikethrough
H1-H4 Headings
• Bullet list
1. Numbered list
☐ Task list
" Block quote
Code block
— Horizontal rule
🔗 Insert link
🖼 Insert image
👁 Toggle preview

The preview updates in real-time as you type, so you can see exactly how your
content will appear.

Tips for Great Content

  1. Use headings to organize - Break up long content into sections
  2. Keep paragraphs short - One idea per paragraph is easier to read
  3. Use lists for steps - Numbered lists are great for instructions
  4. Add images - Visuals make content more engaging
  5. Preview before saving - Check formatting looks right