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
one
two
three
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
Lorem ipsum dolor sit amet
Consectetur adipiscing elit
Integer molestie lorem at massa
Sequential numbering:
You can use sequential numbers...
...or keep all the numbers as 1.
Start numbering with offset:
foo
bar
Task List
- [x] Write the press release
- [ ] Update the website
- [ ] Contact the media
Renders
Horizontal Rule
Horizontal rule 1
Horizontal rule 2
Horizontal rule 3
Emphasis
Bold
**This is bold text**
__This is bold text__
Renders
This is bold text
This is bold text
Italic
*This is italic text*
_This is italic text_
Renders
This is italic text
This is italic text
Strikethrough
~This is strikethrough text~
~~This is strikethrough text~~
Renders
This is strikethrough text
This is strikethrough text
Blockquote
Blockquotes can also be nested...
...by using additional greater-than signs right next to each other...
...or with spaces between arrows.
Blockquotes can also be continued...
...continued...
...continued continued...
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 columns
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 columns
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 columns
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
Indented code
// Some comments
line 1 of code
line 2 of code
line 3 of code
Block code "fences"
Sample text here...
Syntax highlighting
const foo = function (bar) {
return bar++;
};
foo(5);
some.code();
Link
Autolink Literal
Image
Remote image
Remote Alt image
Local image
Like links, Images also have a footnote style syntax
With a reference later in the document defining the URL location:
[id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat"
JSX
JSX Element
<h2>JSX Heading 2</h2>
<abbr title="HyperText Markup Language">HTML</abbr> is a lovely language.
<section>
And here is *markdown* in **JSX**!
</section>
<div># this is not a heading but *this* is emphasis</div>
I can write **Markdown** alongside my _JSX_!
<div>
This is a `p`.
</div>
Renders
JSX Heading 2
HTML is a lovely language.
And here is markdown in JSX !
# this is not a heading but this is emphasis
I can write Markdown alongside my JSX !
JavaScript Expression
Two π° is: {Math.PI * 2}
Renders
Two π° is: 6.283185307179586
{(function () {
const guess = 0.44
if (guess > 0.66) {
return <span style={{color: 'tomato'}}>Look at us.</span>
}
if (guess > 0.33) {
return <span style={{color: 'violet'}}>Who would have guessed?!</span>
}
return <span style={{color: 'goldenrod'}}>Not me.</span>
})()}
Renders
Who would have guessed?!
{/* A comment! */}
Renders nothing
Git
Emoji
Thumbs up: π, thumbs down: π.
Families: π¨βπ¨βπ¦βπ¦
Some flags: π¨π³, πΊπΈ, π·πΊ, π¬π§, π«π·.
Tada π, sparkles β¨, rocket π.
Bug π, wrench π§, zap β‘.
Math
Inline math formulas
a 2 + b 2 \sqrt{a^2 + b^2} a 2 + b 2 β
c = Β± a 2 + b 2 c = \pm\sqrt{a^2 + b^2} c = Β± a 2 + b 2 β
Block math formulas
L = 1 2 Ο v 2 S C L L = \frac{1}{2} \rho v^2 S C_L L = 2 1 β Ο v 2 S C L β
a b c d e f g h i \def\arraystretch{1.5}
\begin{array}{c:c:c}
a & b & c \\ \hline
d & e & f \\
\hdashline
g & h & i
\end{array} a d g β b e h β c f i β β
a = b + c = e + f \begin{equation}
\begin{split}
a &= b + c \\
&= e + f
\end{split}
\end{equation} a β = b + c = e + f β β β
a = b + c d + e = f \begin{align}
a &= b + c \\
d + e &= f
\end{align} a d + e β = b + c = f β β
10 x + 3 y = 2 3 x + 13 y = 4 \begin{alignat}{2}
10 &x + &3 &y = 2 \\
3 &x + &13 &y = 4
\end{alignat} 10 3 β x + x + β 3 13 β y = 2 y = 4 β β
Admonitions
Some
content with
markdown syntax
. Check
this api
.
Some
content with
markdown syntax
. Check
this api
.
Some
content with
markdown syntax
. Check
this api
.
Some
content with
markdown syntax
. Check
this api
.
Some
content with
markdown syntax
. Check
this api
.