Markdown and Mdx parsing is supported via unified
, and other remark and rehype packages. next-mdx-remote
allows us to parse .mdx
and .md
files in a more flexible manner without touching webpack.
GitHub flavored markdown is used. mdx-prism
provides syntax highlighting capabilities for code blocks.
This project is set to follow GitHub markdown style as it is well supported by the community. You can read more here: https://guides.github.com/features/mastering-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 #
or *
.
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 tag
_This text will be italic_ **This text will be bold** _You **can** combine them_
This text will be italic
This text will be bold
You can combine them
- Item 1 - Item 2 - Item 2a - Item 2b
1. Item 1 1. Item 2 1. Item 3 1. Item 3a 1. Item 3b
![GitHub Logo](https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png) Format: ![Alt Text](url)
http://github.com - automatic! [GitHub](http://github.com)
http://github.com - automatic! GitHub
As Kanye West said: > We're living the future so > the present is our past.
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.
I think you should use an <addr>
element here instead.
Here’s an example of how you can use syntax highlighting with GitHub Flavored Markdown:
```js:fancyAlert.js function fancyAlert(arg) { if (arg) { $.facebox({ div: '#foo' }) } } ```
And here's how it looks - nicely colored with styled code titles!
function fancyAlert(arg) { if (arg) { $.facebox({ div: '#foo' }) } }
Here is a simple footnote[^1]. With some additional text after it. [^1]: My reference.
Here is a simple footnote[^1]. With some additional text after it.
[^1]: My reference.
- [x] list syntax required (any unordered or ordered list supported) - [x] 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 |
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 crossed out.