Skip to content

Markdown syntax

Markdown syntax is a lightweight markup language used to format plain text documents. It is commonly used for creating documentation, README files, forum posts, and other types of text content where simple formatting is needed. Markdown uses simple and intuitive syntax, making it easy to learn and use.

Mythradon incorporates Markdown syntax, enabling its utilization in Streams and text data type fields, such as description fields. Markdown is also applicable for Tooltips on fields, offering formatted instructions regarding the use of a particular field.

The following image shows the examples documented on this page being used in a standard text data type description field.

Markdown Examples - Light Markdown Examples - Dark

The following are examples of the Mythradon supported Markdown syntax:

Headers

Headers are created using one or more hash (#) symbols followed by a space and the header text. The number of hash symbols determines the level of the header (from level 1 to 6).

Example:

# Header 1
## Header 2
### Header 3

Emphasis

Text can be emphasized using asterisks (*) or underscores (_). Single asterisks or underscores are used for italic text, while double asterisks or underscores are used for bold text.

Example:

*Italic Text*
_Italic Text_
**Bold Text**
__Bold Text__

Lists

Markdown supports both ordered and unordered lists. Unordered lists can be created using asterisks (*), plus signs (+), or hyphens (-). Ordered lists are created using numbers followed by periods.

Example:

* Item 1
* Item 2
  * Subitem A
  * Subitem B

1. First item
2. Second item

Links are created using square brackets ([]) for the link text followed by parentheses (()) containing the URL.

Example:

[Google](https://www.google.com)

Images

Images are inserted using an exclamation mark (!) followed by square brackets ([]) for the alt text and parentheses (()) containing the URL or path to the image file.

Example:

![Image Alt Text](https://example.com/image.jpg)

Code

Inline code can be enclosed in backticks (``), while code blocks can be created by indenting the code with four spaces or by enclosing it in triple backticks (```).

Example:

Inline code: print("Hello, World!")

# Code block
print("Hello, World!")

Blockquote

Blockquotes are created using a greater than sign (>) followed by the quoted text.

Example:

> This is a blockquote.

Horizontal Rule

Horizontal rules are created using three or more hyphens (-), asterisks (*), or underscores (_).

Example:

___

See Also