Format TextCards using Markdown
Markdown in NodeKit¶
NodeKit supports a defined subset of CommonMark for TextCards. Only the syntax below is supported; unsupported constructs might lead to runtime errors or strange rendering behaviors.
What’s supported¶
- Headers:
#through######followed by a space and text (levels above 6 are rejected). - Italics: use
*text*or_text_; - Bolding: use
**text**or__text__; - Italics+Bolding: use
***text***(and equivalents). - Paragraphs: separate with a blank line;
<br>is not supported. Soft line breaks are folded into spaces; hard breaks are not allowed. - Lists: unordered bullets using any marker (
-,*,+, etc.); ordered lists with1.. - Color spans:
<span style="color:#rrggbb">text</span>or#rrggbbaa. No other inline HTML or style attributes.
What’s not supported¶
Any other CommonMark features are not supported, including:
- Inline code or fenced code blocks (single or triple backticks)
- Links and images
- Blockquotes, tables, and other Markdown extensions
- Any HTML beyond the color
<span>above
Example¶
# Heading
This is a paragraph with **bold** and _italic_ text.
- First item
- Nested item
- Second item
* Same list, different marker
Here is <span style="color:#ff00ff">magenta text</span>.
How do I do linebreaks?¶
Markdown requires two newline characters to cause a line break to be rendered. For example:
By contrast, this would not render a line break: