- 发表于
Markdown 指南
- Authors

- Name
- Sai
- @oniyt1980
简介
通过 unified 以及其他 remark 和 rehype 包支持 Markdown 和 MDX 解析。next-mdx-remote 允许我们以更灵活的方式解析 .mdx 和 .md 文件,而无需触及 webpack。
使用的是 GitHub 风格的 markdown。mdx-prism 为代码块提供语法高亮功能。这里有一个演示,展示一切看起来如何。
以下 markdown 速查表改编自:https://guides.github.com/features/mastering-markdown/
什么是 Markdown?
Markdown 是一种在网页上样式化文本的方法。您可以控制文档的显示方式;格式化文字为粗体或斜体、添加图片和创建列表只是我们可以用 Markdown 做的一些事情。大多数情况下,Markdown 只是普通文本,加上一些非字母字符,如 # 或 *。
语法指南
以下是您可以在 GitHub.com 上或您自己的文本文件中任何地方使用的 Markdown 语法概述。
标题
这是一个 h1 标签
这是一个 h2 标签
这是一个 h4 标签
这是一个 h1 标签
这是一个 h2 标签
这是一个 h4 标签
强调
这段文本将会是斜体
这段文本将会是粗体
你可以组合使用它们
这段文本将会是斜体
这段文本将会是粗体
你可以组合使用它们
列表
无序列表
· 项目 1
· 项目 2
· 项目 2a
· 项目 2b
- 项目 1
- 项目 2
- 项目 2a
- 项目 2b
有序列表
1. 项目 1
2. 项目 2
3. 项目 3
1. 项目 3a
2. 项目 3b
- 项目 1
- 项目 2
- 项目 3
- 项目 3a
- 项目 3b
图片
https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png
格式:url

链接
http://github.com - 自动识别!
GitHub
http://github.com - 自动识别! GitHub
块引用
正如 Kanye West 所说:
我们生活在未来,
所以现在就是我们的过去。
正如 Kanye West 所说:
我们生活在未来, 所以现在就是我们的过去。
行内代码
我认为你应该在这里使用
<addr> 元素。
我认为你应该在这里使用 <addr> 元素。
语法高亮
以下是一个如何将语法高亮与 GitHub Flavored Markdown 一起使用的示例:
```js:fancyAlert.js
function fancyAlert(arg) {
if (arg) {
$.facebox({ div: '#foo' })
}
}
这是它的显示效果 - 带有样式化代码标题的漂亮颜色!
```js:fancyAlert.js
function fancyAlert(arg) {
if (arg) {
$.facebox({ div: '#foo' })
}
}
脚注
这是一个简单的脚注[^1]。后面还有一些附加文本。
[^1]: 我的参考。
这是一个简单的脚注1。后面还有一些附加文本。
任务列表
- [x] 需要列表语法(支持任何无序或有序列表)
- [x] 这是一个已完成的项目
- [ ] 这是一个未完成的项目
- 需要列表语法(支持任何无序或有序列表)
- 这是一个已完成的项目
- 这是一个未完成的项目
表格
您可以通过组合单词列表并用连字符 -(用于第一行)分隔它们,然后用竖线 | 分隔每一列来创建表格:
| 第一个标题 | 第二个标题 |
| ------------------------- | ------------------------- |
| 单元格 1 的内容 | 单元格 2 的内容 |
| 第一列中的内容 | 第二列中的内容 |
| 第一个标题 | 第二个标题 |
|---|---|
| 单元格 1 的内容 | 单元格 2 的内容 |
| 第一列中的内容 | 第二列中的内容 |
删除线
任何用两个波浪号包裹的单词(像 ~~这样~~)都会显示为删除线。
Footnotes
我的参考。 ↩