Markdown is a lightweight markup language designed to simplify text formatting. The main feature of the language is its simple syntax, which makes it maximally easy to read and understand by humans. You can also readily convert it to advanced markup language formats such as Rich Text.
Supported syntax
In BRIX it is possible to format the contents of fields of String type using Markdown. The CommonMark specification is used for this purpose.
Below you will find descriptions and examples of the markup syntax supported in the system. Please note that HTML markup is not supported in the Markdown editor.
The language’s syntax is described in the specification that can be found on the CommonMark Spec website. For testing, use commonmark.js dingus.
Strings
Original Text |
Display |
**Bold** |
Bold |
# h1 |
Header 1 |
## h2 |
Header 2 |
Links
Absolute URLs in string format are automatically converted to links, for example, https://brix365.com.
You can also use the following syntax to format links:
[Main page](https://brix365.com)
Images
>Quote
Lists
- item 1
- item 2
- item 3
Source code
You can insert a single line of code into text:
`code`
code
Or you can insert a code block:
```
more than one
line of code
```
more than one
line of code
Tables
| Column1| Column2 | Column3|
|---------|----------|------------|
|Value1|Value2|Value2|
Column1 |
Column2 |
Column3 |
Value1 |
Value2 |
Value3 |
Found a typo? Select it and press Ctrl+Enter to send us feedback