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
Hello, This Is a Title Inside h1
Hello, This Is a Title Inside h2
Hello, This Is a 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
- 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.
- Very easy!
Ordered List
Sequential numbering:
- 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.
- 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.
- Integer molestie lorem at massa:
- Lorem ipsum dolor sit amet.
- Consectetur adipiscing elit.
- Integer molestie lorem at massa.
Same numbering:
- 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.
Start numbering with offset:
- 108 numbering list.
- 1 numbering list.
- 1 numbering list.
Task List
1- [x] Write the press release.2- [ ] Update the website.3- [ ] Contact the media.
Renders:
- Write the press release.
- Update the website.
- Contact the media.
Horizontal Rule
1___
Renders:
1---
Renders:
1***
Renders:
Emphasis
Bold
1**This is bold text**.23__This is bold text__.
Renders:
This is bold text.
This is bold text.
Italic
1*This is italic text*.23_This is italic text_.
Renders:
This is italic text.
This is italic text.
Strikethrough
1~This is strikethrough text~.23~~This is strikethrough text~~.
Renders:
Blockquote
Nested Blockquote
Blockquotes can also be nested......by using additional greater-than signs right next to each other......or with spaces between arrows.
Continued Blockquote
Blockquotes can also be continued... ...continued... ...continued continued...
Long Blockquote
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":
1Sample text here...
Syntax highlighting:
1const foo = function (bar) {2 return bar++;3};45foo(5);67some.code();
Link
Basic Link
Autolink Literal
Auto-converted link https://github.com/sabertazimi/blog (enable linkify to see):
Footnote
A note1.
Another note2.
Yet another note3.
Image
Local Image
Preview
Remote Image
Preview
Image Title
Preview
Image Footnote
Like links, Images also have a footnote style syntax:
Preview
With a reference later in the document defining the URL location:
1[id]: https://octodex.github.com/images/dojocat.jpg 'The Dojocat'
JSX
JSX Element
1<h2>JSX Heading 2</h2>23<abbr title="HyperText Markup Language">HTML</abbr> is a lovely language.45<section>And here is *markdown* in **JSX**!</section>67<div># this is not a heading but *this* is emphasis</div>89I can write **Markdown** alongside my _JSX_!1011<div>This is a `p`.</div>
Renders:
JSX Heading 2
HTML is a lovely language.
# this is not a heading but this is emphasis
I can write Markdown alongside my JSX!
This is a
p
.JavaScript Expression
1Two 🍰 is: {Math.PI * 2}.
Renders:
Two 🍰 is: 6.283185307179586.
1{(function () {2 const guess = 0.4434 if (guess > 0.66) {5 return <span style={{color: 'tomato'}}>Look at us.</span>6 }78 if (guess > 0.33) {9 return <span style={{color: 'violet'}}>Who would have guessed?!</span>10 }1112 return <span style={{color: 'goldenrod'}}>Not me.</span>13})()}
Renders:
Who would have guessed?!
MDX Comment
1{/* A comment! */}
Renders nothing.
Git
- Commit:
4c5361e
. - Commit (fork): foo@
4c5361e
. - Commit (repo): remarkjs/remark@
e1aa9f6
. - Issue or PR (
#
): #1. - Issue or PR (
GH-
): GH-1. - Issue or PR (fork): foo#1.
- Issue or PR (project): remarkjs/remark#1.
- Mention: @sabertazmi.
Emoji
Thumbs up: 👍, thumbs down: 👎.
Families: 👨👨👦👦.
Some flags: 🇨🇳, 🇺🇸, 🇷🇺, 🇬🇧, 🇫🇷.
Tada 🎉, sparkles ✨, rocket 🚀.
Bug 🐛, wrench 🔧, zap ⚡.
Math
Inline Math Formula
This is a math formula .
This is another math formula .
Block Math Formula
Admonition
Green Admonition
Blue Admonition
Yellow Admonition
Red Admonition
Title Admonition
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.
Two 🍰 is: 6.283185307179586.
Look at us.