How to edit text widgets using Markdown
The text widgets in Swonkie’s Insights dashboards allow you to add custom information, comments, conclusions, or highlights about the data you’re analysing. To help you present this information in a more organised and visually clear way, the notes support formatting using Markdown.
In this article, we explain which Markdown elements are supported and how to use them.
What is Markdown?
Markdown is a lightweight markup language that allows you to apply formatting such as bold, italic, lists, headings, and more — quickly and easily, using simple symbols.
Supported Formatting
Below is a list of supported Markdown elements and how to use them:
| Headings | Use the # symbol at the beginning of a line to create titles. |
| |
| Bold | Place text between double asterisks **. | **Bold text** | Bold text |
| Italic | Place text between single asterisks *. | *Italic text* | Italic text |
| Strikethrough | Place text between double tildes ~~. | ~~Strikethrough text~~ | S̶t̶r̶i̶k̶e̶t̶h̶r̶o̶u̶g̶h̶ ̶t̶e̶x̶t̶ |
| Bulleted List | Start each line with a hyphen -. |
|
|
| Numbered List | Use numbers followed by a period. 1., 2., ... |
|
|
| Inline Code | Place text between backticks `. | Example of `code` | Example of code |
| Code Block | To display multiple lines of code, use three backticks ``` before and after. | ```Line 1 of code Line 2 of code``` | |
| Blockquote | Start the line with a > symbol. | > This is a quote or highlight. |
|
| Divider Line | Use three hyphens ---. | --- |
💡 Usage Tips
- Use headings and bold text to highlight key sections of your analysis.
- Create lists for conclusions, hypotheses, or next steps.
- Use blockquotes to highlight recommendations.
- Separate notes with lines for better readability.