Text editor
Markdown features
We invite you to check out the Official Markdown page to get more familiar with markdown.
The standard features mentioned below are supported.
Heading
# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
These headers will render with different font sizes, where Header 1 is the largest, and Header 5 is the smallest.
✅ Do this
# Here's a Heading
❌ Don't do this
#Here's a Heading
Bold
To create bold text, surround it with ** or __, e.g. **bold text**
✅ Do this
Love**is**bold
**Love is bold**
❌ Don't do this
Love__is__bold
**Love is bold **
Italic
To create italic text, surround it with * or _, e.g. *italic text*
Strikethrough
To create strikethrough text, surround it with ~~, e.g. ~~strikethrough text~~
Blockquote
Blockquotes are created by starting a line with >
e.g.
> blockquote
✅ Do this
Try to put a blank line before...
> This is a blockquote
...and after a blockquote.
❌ Don't do this
Without blank lines, the formatting may not render correctly.
> This is a blockquote
Don't do this!
Ordered List
Ordered lists are created by placing a number followed by a dot (.) at the beginning of each line.
1. First item
2. Second item
3. Third item
Unordered List
Unordered lists are created by placing a '-' at the beginning of each line.
- First item
- Second item
- Third item
✅ Do separate lists with blank lines before and after each list.
Inline code
Inline code is done using backticks
`inline code`
Horizontal Rule
Horizontal rules are created by placing --- on a line.
✅ Do this
Some content.
---
Some other content.
❌ Don't do this
Some content.
---
Some other content.
Link
Links are created using the following syntax: [Name of your link](https://url-to-your.link.ext)
Image
Images are embedded using the following syntax: 
Table
Simple tables can be rendered with the following:
| Syntax | Description |
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |
The rendering will have a similar appearance as the following table.
| Syntax | Description |
|---|---|
| Header | Title |
| Paragraph | Text |
Code Block
Code blocks are created using the following syntax. The language name (here json) is optional.
```json
{
"firstName": "John",
"lastName": "Smith",
"age": 25
}
```
Astran features
Alerts
danger, warning and info blocks are created using the following syntax.
::danger
Danger alert
::
Replace ::danger with ::warning or ::info to change the alert type as needed.
✅ Do separate alert blocks with blank lines before and after.
Link to internal documents
A text in the form /path/to/a/document/in/bucket.extension or /path/to/a/folder/ will be interpreted as an internal link.
Note that links cannot contain references to files or folders which have spaces in their names.
We recommend naming your files and folders without spaces and avoiding special characters. Alphanumeric characters, digits, '-', and '_' should be preferred.
::
This link will be clickable and will try to open the associated document for preview.
You can upload a file in your kit by dropping it in the text area (1 file at a time) or clicking on the Upload file icon in the toolbar.
This will upload the selected file in the /data prefix of the bucket associated to your kit.
You can navigate and point to content of your bucket by typing / in the text area.
This will open a dropdown for you to select folders and files you want to reference.
When referencing an internal document or folder, please note that /data/ points to the folder named data while /data points to the file named data.
You can have both a file and a folder having the same name.
:::
Files you upload or drop will have spaces replaced by a _, e.g. My file.pdf will be uploaded as My_file.pdf, since links with spaces are not accepted.
Embedding documents
Embed documents are created using the following syntax .
The embedded document must exist at /link/to/document.pdf within the bucket associated with the checklist.
It will render the document in case its format is supported. Otherwise, a link to download it will be available. Documents which are more than 5MB will not be rendered.