- 发布于
Markdown 指南
- 作者

- 姓名
- Tails Azimuth
简介
Markdown 和 MDX 的解析通过 unified 以及其他 remark 和 rehype 包来实现。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 语法概览。
标题
# 这是一级标题
## 这是二级标题
#### 这是四级标题
这是一级标题
这是二级标题
这是四级标题
强调
_这段文字将是斜体_
**这段文字将是粗体**
_你**可以**组合使用它们_
这段文字将是斜体
这段文字将是粗体
你可以组合使用它们
列表
无序列表
- 项目 1
- 项目 2
- 项目 2a
- 项目 2b
- 项目 1
- 项目 2
- 项目 2a
- 项目 2b
有序列表
1. 项目 1
1. 项目 2
1. 项目 3
1. 项目 3a
1. 项目 3b
- 项目 1
- 项目 2
- 项目 3
- 项目 3a
- 项目 3b
图片

格式:

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