Markdown and Mdx parsing is supported via
unified, and other remark and rehype packages.
next-mdx-remote allows us to parse
.md files in a more flexible manner without touching webpack.
GitHub flavored markdown is used.
mdx-prism provides syntax highlighting capabilities for code blocks. Here's a demo of how everything looks.
The following markdown cheatsheet is adapted from: https://guides.github.com/features/mastering-markdown/
What is Markdown?
Markdown is a way to style text on the web. You control the display of the document; formatting words as bold or italic, adding images, and creating lists are just a few of the things we can do with Markdown. Mostly, Markdown is just regular text with a few non-alphabetic characters thrown in, like
Here’s an overview of Markdown syntax that you can use anywhere on GitHub.com or in your own text files.
# This is a h1 tag ## This is a h2 tag #### This is a h4 tagmd
This is a h1 tag
This is a h2 tag
This is a h4 tag
_This text will be italic_ **This text will be bold** _You **can** combine them_text
This text will be italic
This text will be bold
You can combine them
- Item 1 - Item 2 - Item 2a - Item 2bmd
- Item 1
- Item 2
- Item 2a
- Item 2b
1. Item 1 1. Item 2 1. Item 3 1. Item 3a 1. Item 3bmd
- Item 1
- Item 2
- Item 3
- Item 3a
- Item 3b
![GitHub Logo](https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png) Format: ![Alt Text](url)md
http://github.com - automatic! [GitHub](http://github.com)md
http://github.com - automatic! GitHub
As Kanye West said: > We're living the future so > the present is our past.md
As Kanye West said:
We're living the future so the present is our past.
I think you should use an `<addr>` element here instead.md
I think you should use an
<addr> element here instead.
Here is a simple footnote[^1]. With some additional text after it. [^1]: My reference.md
Here is a simple footnote1. With some additional text after it.
- [x] list syntax required (any unordered or ordered list supported) - [x] this is a complete item - [ ] this is an incomplete itemmd
- list syntax required (any unordered or ordered list supported)
- this is a complete item
- this is an incomplete item
You can create tables by assembling a list of words and dividing them with hyphens
- (for the first row), and then separating each column with a pipe
| First Header | Second Header | | --------------------------- | ---------------------------- | | Content from cell 1 | Content from cell 2 | | Content in the first column | Content in the second column |md
|First Header||Second Header|
|Content from cell 1||Content from cell 2|
|Content in the first column||Content in the second column|
Any word wrapped with two tildes (like
~~this~~) will appear
My reference. ↩