User Guide
Markdown Guide
Learn how to write Markdown for FAQs, replies, and public pages
QAries supports Markdown in FAQs, agent replies, internal notes, and web page bodies. Headings, lists, links, and tables help make long explanations and procedures easier to read
Markdown Usage Flow
1
Use Basic Formatting
Use headings and lists to structure your text
- Use # or ## for headings
- Use - for bullet lists
- Use numbered lists when the order of steps matters
2
Use Links and Code
Use links and code blocks to add supporting information
- Write links as [label](URL)
- Use inline code for commands or setting values
- Use code blocks for longer code or logs
3
Use Tables
Use tables for comparisons and setting lists
- Tables work well for plan differences or configuration lists
- If a table has too many columns, split it into smaller sections
- Avoid very wide tables so the content remains readable on mobile
4
Check the Preview
Switch between input and preview before saving
- Preview FAQs and web pages before publishing
- Check links and formatting before sending customer replies
- User replies are treated as plain text and are not rendered as Markdown
Before You Start
- Open an editor that supports Markdown input
- Check the preview before publishing or sending content
- Decide whether the text is customer-facing or internal-only
Writing Tips
- For customer-facing text, keep formatting simple and rely on headings and lists
- Internal notes can use Markdown to organize investigation logs and action items
- Avoid duplicating the same explanation in FAQs and web pages; link related content instead
What to Do Next
After learning the basics, use previews while editing FAQs, agent replies, and web page bodies