Browse documentation
Writing an article
Articles are written in Markdown, so you can format headings, lists, code, links, and images. This article covers creating and editing one.
Creating an article
- Select Knowledge in the sidebar, then New article.
- Fill in:
- Title (required)
- Category (optional) — see Categories and tags
- Status — Draft (default), Published, or Archived
- Tags — comma-separated
- Body (required) — Markdown
- Select Create.
Writing in Markdown
The body supports headings, bold, italic, inline code, code blocks, lists, and links. Use the Add image button to upload a picture (PNG, JPEG, GIF, or WebP) — it's inserted as Markdown at your cursor.
Editing and reading
Open an article to read it (rendered Markdown) or select Edit to change it. The header also has Publish and Archive buttons to move it between statuses, and a Delete button. See Article versions and status for how edits are versioned.
Finding articles
The Knowledge Base list has a search box that matches article titles, content, and tags, plus category and status filters. This makes it easy to find the right runbook when you need it.
Working with the Helpdesk
When both modules are enabled, articles connect to tickets:
- Attach relevant articles to a ticket (they show on the ticket's Knowledge card).
- Link an article in a reply to send the requestor a helpful how-to.
- Save a resolved ticket as a draft article to capture a new runbook as you work.
Notes & tips
- Keep an article in Draft while you write it, then Publish when it's ready for the team.
- Add clear tags — they're searchable and make related articles easy to find.