Markdown
Interfaces are how users interact with fields on content pages. These are markdown notation text editors and also support GitHub Flavored Markdown.
- Types:
Text
Headline
Supports Atx format headers. Uses 1-6 hash characters at the beginning of a line, corresponding to header levels 1-6.
# this is head1
## this is head2
### this is head3
#### this is head4
##### this is head5
###### this is head6
Itemization
Lists
A hyphen (-), plus (+), asterisk (ɑ*) and a space can be inserted to display the list. You can also precede those symbols with
tab
or two spaces to make a nested list.
- List1
- List1-1
- List2
- List2-1
- List3
- List1
- List1-1
- List2
- List2-1
- List3
Numbered Lists
1. List1
2. List2
3. List3
- List1
- List2
- List3
Asterisk
* to do
* done
- to do
- done
Quotation
The greater-than sign allows text to be formatted like quotation marks.
> Keep it simple.
Keep it simple.
Code snippet
Inline code
Use the grave accent key (`) for inline code snippets.
React as a `script` tag
React as a script
tag
Code block
Large code blocks can be displayed within the content by surrounding them with three grave accent keys (`).
```
import { createRoot } from 'react-dom/client';
function HelloMessage({ name }) {
return <div>Hello {name}</div>;
}
```
import { createRoot } from 'react-dom/client';
function HelloMessage({ name }) {
return <div>Hello {name}</div>;
}
It also supports code highlighting. You can add syntax highlighting to JavaScript code blocks as follows
~~~js
import { createRoot } from 'react-dom/client';
function HelloMessage({ name }) {
return <div>Hello {name}</div>;
}
~~~
import { createRoot } from 'react-dom/client';
function HelloMessage({ name }) {
return <div>Hello {name}</div>;
}
Text format
Emphasis
Surrounding text with a double asterisk (**) makes it bold, and surrounding it with a single asterisk character makes it italic. You can also combine them.
**Strong Text**
*Italic text*
***Italic + Strong text***
Strong Text
Italic text
Italic + Strong text
Strike through line
Surrounding the text with a single tilde (~) character will cause a strike through line to appear.
React has been the most used library for ~5~6 consecutive years since 2016
React has been the most used library for 56 consecutive years since 2016
Image
![Text](https://xxxx)
syntax can be used to display images.
![Icon](https://cdn.collections.dev/apple-icon.png)
Link
[Text](https://xxxx)
syntax can be used to display inline link.
[Collections](https://collections.dev/) provides the best developer experience.
Collections (opens in a new tab) provides the best developer experience.
Delimiter line
Separator lines can be displayed by writing three or more consecutive asterisks, underscores, or hyphens.
***
___
---
Table
|Left align|Center align|Right align|
|:--|:--:|--:|
|left|center|right|
Left align | Center align | Right align |
---|---|---|
left | center | right |
Checkbox
- [ ] todo
- [x] done
- todo
- done