Helpdesky articles are written in Markdown with a few helpful extensions. This article shows them all in one place.
Headings
Use # through ###### for h1–h6. The h1 is always your article title, so start your body at ##.
Callouts
Note: Blockquotes render as soft callouts in the help center.
⚠️ Warning: Stack two blockquote symbols for a stronger emphasis.
Lists
- Bullet one
- Bullet two
- Nested bullet
- Bullet three
- Ordered step
- Another step
- Final step
Code
Inline like npm install helpdesky or fenced blocks with syntax highlighting:
import { Helpdesky } from "helpdesky";
const hd = new Helpdesky({ apiKey: process.env.HELPDESKY_KEY! });
await hd.articles.create({ title: "Hello world", content: "..." });
Tables
| Plan | Articles | AI answers | Custom domain |
|---|---|---|---|
| Free | 25 | — | — |
| Pro | Unlimited | ✅ | ✅ |
| Unlimited | Unlimited | ✅ | ✅ (3 slots) |
Images
YouTube video
Paste any YouTube link on its own line and Helpdesky embeds it:
Horizontal rule
That's the full toolkit.