MDXMarkdownReactNext.jsFrontend DevelopmentWeb Development

Implement Fancy MDX

Tue Apr 26 2022Tue May 03 20229 minutes

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:
1. Lorem ipsum dolor sit amet:
  1. Lorem ipsum dolor sit amet.
  2. Consectetur adipiscing elit.
  3. Integer molestie lorem at massa.
2. Consectetur adipiscing elit:
  1. Lorem ipsum dolor sit amet.
3. Integer molestie lorem at massa:
  1. Lorem ipsum dolor sit amet.
  2. Consectetur adipiscing elit.
Consectetur adipiscing elit:
1. Lorem ipsum dolor sit amet:
  1. Lorem ipsum dolor sit amet.
  2. Consectetur adipiscing elit.
2. Consectetur adipiscing elit:
  1. Lorem ipsum dolor sit amet.
  2. Consectetur adipiscing elit.
  3. Integer molestie lorem at massa.
Integer molestie lorem at massa:
1. Lorem ipsum dolor sit amet.
2. Consectetur adipiscing elit.
3. Integer molestie lorem at massa.

Same numbering:

You can keep all the numbers as 1.:
1. Lorem ipsum dolor sit amet:
  1. Lorem ipsum dolor sit amet.
  2. Lorem ipsum dolor sit amet.
  3. Lorem ipsum dolor sit amet.
2. Lorem ipsum dolor sit amet:
  1. Lorem ipsum dolor sit amet.
3. Lorem ipsum dolor sit amet:
  1. Lorem ipsum dolor sit amet.
  2. Lorem ipsum dolor sit amet.
Lorem ipsum dolor sit amet:
1. Lorem ipsum dolor sit amet.
2. Lorem ipsum dolor sit amet.
3. 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**.
2
3__This is bold text__.

Renders:

This is bold text.

Italic

1*This is italic text*.
2
3_This is italic text_.

Renders:

This is italic text.

Strikethrough

1~This is strikethrough text~.
2
3~~This is strikethrough text~~.

Renders:

~~This is strikethrough text~~.

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};
4
5foo(5);
6
7some.code();

Link

Basic Link

Link text.

Link with title.

Autolink Literal

Auto-converted link https://github.com/sabertazimi/blog (enable linkify to see):

Footnote

A note¹.

Another note².

Yet another note³.

Image

Local Image

Preview

image

Remote Image

Preview

Minion

Image Title

Preview

The Stormtroopocat

Stormtroopocat

Image Footnote

Like links, Images also have a footnote style syntax:

Preview

The Dojocat

Alt text

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>
2
3<abbr title="HyperText Markup Language">HTML</abbr> is a lovely language.
4
5<section>And here is *markdown* in **JSX**!</section>
6
7<div># this is not a heading but *this* is emphasis</div>
8
9I can write **Markdown** alongside my _JSX_!
10
11<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!

This is a p.

JavaScript Expression

1Two 🍰 is: {Math.PI * 2}.

Renders:

Two 🍰 is: 6.283185307179586.

1{(function () {
2  const guess = 0.44
3
4  if (guess > 0.66) {
5    return <span style={{color: 'tomato'}}>Look at us.</span>
6  }
7
8  if (guess > 0.33) {
9    return <span style={{color: 'violet'}}>Who would have guessed?!</span>
10  }
11
12  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

\sqrt{a^2 + b^2}

c = \pm\sqrt{a^2 + b^2}

Block Math Formula

L = \frac{1}{2} \rho v^2 S C_L

\def\arraystretch{1.5} \begin{array}{c:c:c} a & b & c \\ \hline d & e & f \\ \hdashline g & h & i \end{array}

\begin{equation} \begin{split} a &= b + c \\ &= e + f \end{split} \end{equation}

\begin{align} a &= b + c \\ d + e &= f \end{align}

\begin{alignat}{2} 10 &x + &3 &y = 2 \\ 3 &x + &13 &y = 4 \end{alignat}

Admonition

Green Admonition

Some content with markdown syntax. Check this api.

Blue Admonition

Some content with markdown syntax. Check this api.

Yellow Admonition

Some content with markdown syntax. Check this api.

Red Admonition

Some content with markdown syntax. Check this api.

Title Admonition

Your Title

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.
1. List.
  1. List.
  2. List.
  3. List.
2. List.
  1. List.
3. List.
  1. List.
  2. List.
List.
List.

MDX in Admonition

Two 🍰 is: 6.283185307179586.

Look at us.

MDX Component

Big note. ↩
Small note. ↩
Smallest note. ↩

Implement Fancy MDX in Next.js

Built with React and Next

Last Built Time 2022/5/3 14:33:42

Implement Fancy MDX

Fancy MDX

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

Ordered List

Task List

Horizontal Rule

Emphasis

Bold

Italic

Strikethrough

Blockquote

Nested Blockquote

Continued Blockquote

Long Blockquote

Table

Basic Table

Left Aligned Table

Center Aligned Table

Right Aligned Table

Code

Link

Basic Link

Autolink Literal

Footnote

Image

Local Image

Remote Image

Image Title

Image Footnote

JSX

JSX Element

JSX Heading 2

JavaScript Expression

MDX Comment

Git

Emoji

Math

Inline Math Formula

Block Math Formula

Admonition

Green Admonition

Blue Admonition

Yellow Admonition

Red Admonition

Title Admonition

MDX Component

Footnotes

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`