Markdown Basics

A plain-English guide to formatting text in Help Center articles using Markdown.

All Help Center articles are written in Markdown — a simple way of formatting text using plain characters. Instead of clicking a "Bold" button like in Word, you just type a couple of symbols around your text.

Think of it like shorthand: **bold** becomes bold, and ## Heading becomes a section heading.

The file extension for these articles is .mdx — you can open and edit .mdx files with any plain-text editor (Notepad, TextEdit, VS Code, etc.).

Article Structure

Every article starts with a small block at the top called frontmatter. This tells the Help Center the article's title and description. It looks like this:

---
title: Your Article Title
description: A one-sentence summary of what this article covers.
---

Everything below the frontmatter is the actual content of your article, written in Markdown.

Headings

Use # symbols to create headings. The more # symbols, the smaller the heading.

## Main Section

### Sub-section

#### Smaller sub-section

Tip: Always start with ## for your first section heading. The page title is set automatically from the frontmatter — you do not need a # heading in the body.

Bold and Italic

What you type	What it looks like
`important word`	important word
`emphasized word`	emphasized word
`*bold and italic*`	bold and italic

Bullet Lists

Use a - at the start of a line, followed by a space:

- First item
- Second item
- Third item

Renders as:

First item
Second item
Third item

Numbered Lists

Use 1., 2., 3. etc.:

1. Open the app
2. Click on Inventory
3. Select a product

Renders as:

Open the app
Click on Inventory
Select a product

Links

[Text to display](https://example.com)

To link to another Help Center article, use its path instead of a full URL:

[Setting Up Your Pharmacy](/docs/getting-started/setting-up-your-pharmacy)

Horizontal Dividers

Use three dashes on a line by themselves to add a visual separator between sections:

---

Inline Code and Code Blocks

Use a single backtick for short code or technical terms inline: `like this`

Use three backticks for a full code block:

```
Your code or text here
```

Quick Reference Cheat Sheet

## Heading 2
### Heading 3

**bold**
*italic*

- Bullet item
1. Numbered item

[Link text](https://url.com)
[Internal link](/docs/folder/article-name)

![Image description](/images/filename.png)

---

`inline code`