
Fancy MDX
All your .md and .mdx files under the contents directory
will be rendered with MDX,
it's an advanced Markdown format with React component support.
Heading
Renders:
Hello, This Is a Title Inside h1
Hello, This Is a Title Inside h2
Hello, This Is a very very very very very very very very very long Title Inside h2
Hello, This Is a Title Inside h3
Hello, This Is a very very very very very very very very very long Title Inside h3
Hello, This Is a Title Inside h4
Hello, This Is a Title Inside h5
Hello, This Is a Title Inside h6
List
Unordered List
Renders:
- Create a list by starting a line with
+,-, or*. - Sub-lists are made by indenting 2 spaces:
- Marker character change forces new list start:
- Ac tristique libero volutpat at.
- Facilisis in pretium nisl aliquet.
- Nulla volutpat aliquam velit.
- Marker character change forces new list start:
- Very easy!
Ordered List
Sequential numbering:
Renders:
- Lorem ipsum dolor sit amet:
- Lorem ipsum dolor sit amet:
- Lorem ipsum dolor sit amet.
- Consectetur adipiscing elit.
- Integer molestie lorem at massa.
- Consectetur adipiscing elit:
- Lorem ipsum dolor sit amet.
- Integer molestie lorem at massa:
- Lorem ipsum dolor sit amet.
- Consectetur adipiscing elit.
- Lorem ipsum dolor sit amet:
- Consectetur adipiscing elit:
- Lorem ipsum dolor sit amet:
- Lorem ipsum dolor sit amet.
- Consectetur adipiscing elit.
- Consectetur adipiscing elit:
- Lorem ipsum dolor sit amet.
- Consectetur adipiscing elit.
- Integer molestie lorem at massa.
- Lorem ipsum dolor sit amet:
- Integer molestie lorem at massa:
- Lorem ipsum dolor sit amet.
- Consectetur adipiscing elit.
- Integer molestie lorem at massa.
Same numbering:
Renders:
- You can keep all the numbers as
1.:- Lorem ipsum dolor sit amet:
- Lorem ipsum dolor sit amet.
- Lorem ipsum dolor sit amet.
- Lorem ipsum dolor sit amet.
- Lorem ipsum dolor sit amet:
- Lorem ipsum dolor sit amet.
- Lorem ipsum dolor sit amet:
- Lorem ipsum dolor sit amet.
- Lorem ipsum dolor sit amet.
- Lorem ipsum dolor sit amet:
- Lorem ipsum dolor sit amet:
- Lorem ipsum dolor sit amet.
- Lorem ipsum dolor sit amet.
- Lorem ipsum dolor sit amet.
Start numbering with offset:
Renders:
- 108 numbering list.
- 1 numbering list.
- 1 numbering list.
Task List
Renders:
- Write the press release.
- Update the website.
- Contact the media.
Horizontal Rule
Renders:
Renders:
Renders:
Emphasis
Bold
Renders:
This is bold text.
This is bold text.
Italic
Renders:
This is italic text.
This is italic text.
Strikethrough
Renders:
This is strikethrough text.
This is strikethrough text.
Blockquote
Nested Blockquote
Renders:
Blockquotes can also be nested...
...by using additional greater-than signs right next to each other...
...or with spaces between arrows.
Continued Blockquote
Renders:
Blockquotes can also be continued... ...continued... ...continued continued...
Long Blockquote
Renders:
Blockquotes can be very very very very very very very very long...very very very very very very very very long...very very very very very very very very long...very very very very very very very very long...very very very very very very very very long...very very very very very very very very long...very very very very very very very very long...very very very very very very very very long...very very very very very very very very long...
Table
Basic Table
| a | b | c | d |
|---|---|---|---|
| 10 | 200 | 3600 | 48000 |
| 200 | 10 | 48000 | 3600 |
| 3600 | 48000 | 10 | 200 |
| 48000 | 3600 | 200 | 10 |
| Option | Description |
|---|---|
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
Left Aligned Table
| Option | Description |
|---|---|
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
Center Aligned Table
| Option | Description |
|---|---|
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
Right Aligned Table
| Option | Description |
|---|---|
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
Code
Inline code.
Block code "fences":
Syntax highlighting:
Link
Basic Link
Renders:
Autolink Literal
Auto-converted link:
www.example.com: www.example.com.https://example.com: https://example.com.contact@example.com: contact@example.com.
Footnote
Renders (footnote renders at the end of the document):
A note1.
Another note2.
Yet another note3.
Image
Local Image
Renders:
No Image Available
Remote Image
Renders:
No Image Available
Error Image
Renders:
No Image Available
Image Title
Renders:
No Image Available
The Stormtroopocat
Image Footnote
Like links, Images also have a footnote style syntax:
With a reference later in the document defining the URL location:
Renders:
No Image Available
The Dojocat
JSX
JSX Element
Renders:
JSX Heading 2
HTML is a lovely language.
I can write Markdown alongside my JSX!
p.JavaScript Expression
Renders:
Two 🍰 is: 6.283185307179586.
Renders:
Who would have guessed?!MDX Comment
Renders nothing.
Git
- Commit
4c5361e:4c5361e. - Commit (fork)
foo@4c5361e: foo@4c5361e. - Commit (project)
remarkjs/remark@e1aa9f6: remarkjs/remark@e1aa9f6. - Issue or PR (
#)#1: #1. - Issue or PR (
GH-)GH-100: GH-100. - Issue or PR (fork)
foo#1: foo#1. - Issue or PR (project)
remarkjs/remark#1: remarkjs/remark#1. - Mention
@sabertazimi: @sabertazimi.
Emoji
Thumbs up :+1: 👍, thumbs down :-1: 👎.
Families :family_man_man_boy_boy: 👨👨👦👦.
Some flags :cn:, :us:, :ru:, :uk:, :fr: 🇨🇳, 🇺🇸, 🇷🇺, 🇬🇧, 🇫🇷.
Tada :tada: 🎉, sparkles :sparkles: ✨, rocket :rocket: 🚀.
Bug :bug: 🐛, wrench :wrench: 🔧, zap :zap: ⚡.
Math
Inline Math Formula
This is a math formula $\sqrt{a^2 + b^2}$ .
This is another math formula $c = \pm\sqrt{a^2 + b^2}$ .
Block Math Formula
Admonition
Green Admonition
Renders:
Some content with markdown syntax. Check this api.
Some content with markdown syntax. Check this api.
Blue Admonition
Renders:
Some content with markdown syntax. Check this api.
Some content with markdown syntax. Check this api.
Yellow Admonition
Renders:
Some content with markdown syntax. Check this api.
Some content with markdown syntax. Check this api.
Red Admonition
Renders:
Some content with markdown syntax. Check this api.
Some content with markdown syntax. Check this api.
Title Admonition
Renders:
Some content with markdown syntax.
I can write Markdown alongside my JSX!
Some content with markdown syntax.
I can write Markdown alongside my JSX!
Some content with markdown syntax.
I can write Markdown alongside my JSX!
Some content with markdown syntax.
I can write Markdown alongside my JSX!
- List.
- List.
- List.
- List.
- List.
- List.
- List.
- List.
- List.
- List.
- List.
- List.
- List.
- List.
- List.
- List.
- List.
- List.
- List.
- List.
- List.
- List.
- List.
- List.
- List.
- List.
Renders:
Two 🍰 is: 6.283185307179586.
Look at us.Nested Admonition
Renders:
Parent content
Child content
Deep child content
MDX Component
Renders:
Renders:
Renders: