Published on

Markdown 语法指南

Authors
  • avatar
    Name
    艾森
    Twitter

介绍

Markdown 和 Mdx 解析支持 unified,以及其他 remark 和 rehype 包。next-mdx-remote 允许我们以更灵活的方式解析 .mdx.md 文件,而无需接触 webpack。

GitHub flavored markdown 被使用。mdx-prism 提供了代码块语法高亮功能。以下是所有内容的样子。

以下 markdown 速查表改编自:https://guides.github.com/features/mastering-markdown/

什么是 Markdown?

Markdown 是一种在网页上样式化文本的方式。您控制文档的显示方式;格式化单词为粗体或斜体、添加图像、创建列表等只是我们可以使用 Markdown 完成的事情之一。主要,Markdown 只是常规文本,其中包含一些非字母字符,例如 #*

语法指南

以下是 Markdown 语法概述,您可以在 GitHub.com 或您自己的文本文件中使用。

Headers

# 这是 h1 标签

## 这是 h2 标签

#### 这是 h4 标签

这是 h1 标签

这是 h2 标签

这是 h4 标签

强调

_这是斜体_

**这是粗体**

_你可以将它们结合起来_

这是斜体

这是粗体

你可以将它们结合起来

列表

无序列表

- 项目 1
- 项目 2
  - 项目 2a
  - 项目 2b
  • 项目 1
  • 项目 2
    • 项目 2a
    • 项目 2b

Ordered

1. 项目 1
1. 项目 2
1. 项目 3
   1. 项目 3a
   1. 项目 3b
  1. 项目 1
  2. 项目 2
  3. 项目 3
    1. 项目 3a
    2. 项目 3b

图片

![GitHub Logo](https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png)
Format: ![Alt Text](url)

GitHub Logo

链接

http://github.com - automatic!
[GitHub](http://github.com)

http://github.com - automatic! GitHub

引用

正如 Kanye West 所说:

> 我们生活在未来,所以现在就是过去。

正如 Kanye West 所说:

我们生活在未来,所以现在就是过去。

内联代码

我认为你应该使用一个
`<addr>` 元素。

我认为你应该使用一个 <addr> 元素。

语法高亮

以下是使用 GitHub Flavored 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] 这是完整项目
- [ ] 这是未完成项目
  • 列表语法要求(任何无序或有序列表都支持)
  • 这是完整项目
  • 这是未完成项目

表格

你可以通过将单词列表与连字符 - (对于第一行)和每个列用管道 | 分隔来创建表格:

| First Header                | Second Header                |
| --------------------------- | ---------------------------- |
| Content from cell 1         | Content from cell 2          |
| Content in the first column | Content in the second column |
First HeaderSecond Header
Content from cell 1Content from cell 2
Content in the first columnContent in the second column

删除线

任何用两个波浪号(如 ~~this~~)包裹的单词将显示为 删除线

Footnotes

  1. 我的参考。