Skip to content

Latest commit

 

History

History
240 lines (176 loc) · 4.41 KB

markdown.md

File metadata and controls

240 lines (176 loc) · 4.41 KB

Markdown 拓展

Header Anchors

所有的标题将会自动地应用 anchor 链接，anchor 的渲染可以通过 markdown.anchor 来配置。

链接

内部链接

内部的、并以 .md or .html 结尾的链接，将会被转换成 <router-link> 用于 SPA 导航。

站内的每一个子文件夹都应当有一个 README.md 文件，它会被自动编译为 index.html。

::: tip 在链接到一个文件夹的 index.html 时，确保你的链接以 / 结尾，否则该链接将导致 404。比如，用 /config/ 而不是 /config。 :::

如果你想要链接到另一个 markdown 文件：

  1. 确保链接以 .html 或 .md 结尾；
  2. 确保路径大小写正确，因为路径的匹配是大小写敏感的。

示例

以如下的文件结构为例：

.
├─ README.md
├─ foo
│  ├─ README.md
│  ├─ one.md
│  └─ two.md
└─ bar
   ├─ README.md
   ├─ three.md
   └─ four.md

[Home](/) <!-- 跳转到根部的 README.md -->
[foo](/foo/) <!-- 跳转到 foo 文件夹的 index.html -->
[foo heading anchor](/foo/#heading) <!-- 跳转到 foo/index.html 的特定 anchor 位置 -->
[foo - one](/foo/one.html) <!-- 具体文件可以使用 .html 结尾 -->
[foo - two](/foo/two.md) <!-- 也可以用 .md -->

外部链接

外部的链接将会被自动地设置为 target="_blank":

Front Matter

VuePress 提供了对 YAML front matter 开箱即用的支持:

---
title: Blogging Like a Hacker
lang: en-US
---

这些数据可以在当前页的正文中使用，在任意的自定义或主题组件中，它可以通过 $page 来访问。

title 和 lang 的 meta 将会被自动地注入到当前的页面中，当然你也可以指定一些额外需要注入的 meta：

---
meta:
  - name: description
    content: hello
  - name: keywords
    content: super duper SEO
---

其他格式的 Front Matter

除了 YAML 之外，VuePress 也支持 JSON 或者 TOML 格式的 front matter。

JSON front matter 需要以花括号开头和结尾：

---
{
  "title": "Blogging Like a Hacker",
  "lang": "en-US"
}
---

TOML front matter 需要显式地标注为 TOML：

---toml
title = "Blogging Like a Hacker"
lang = "en-US"
---

GitHub 风格的表格

Input

| Tables        | Are           | Cool  |
| ------------- |:-------------:| -----:|
| col 3 is      | right-aligned | $1600 |
| col 2 is      | centered      |   $12 |
| zebra stripes | are neat      |    $1 |

Output

Tables Are Cool
col 3 is right-aligned $1600
col 2 is centered $12
zebra stripes are neat $1

Emoji

Input

:tada: :100:

Output

🎉 💯

目录

Input

[[toc]]

Output

[[toc]]

目录（Table of Contents）的渲染可以通过 markdown.toc 选项来配置。

自定义容器

Input

::: tip
This is a tip
:::

::: warning
This is a warning
:::

::: danger
This is a dangerous warning
:::

Output

::: tip This is a tip :::

::: warning This is a warning :::

::: danger This is a dangerous thing :::

你也可以自定义块中的标题：

::: danger STOP
Danger zone, do not proceed
:::

::: danger STOP Danger zone, do not proceed :::

代码块中的行高亮

Input

``` js{4}
export default {
  data () {
    return {
      msg: 'Highlighted!'
    }
  }
}
```

Output

export default {
  data () {
    return {
      msg: 'Highlighted!'
    }
  }
}

进阶配置

VuePress 使用 markdown-it 来渲染 Markdown，上述大多数的拓展也都是通过自定义的插件实现的。想要进一步的话，你可以通过 .vuepress/config.js 的 markdown 选项，来对当前的 markdown-it 实例做一些自定义的配置：

module.exports = {
  markdown: {
    // markdown-it-anchor 的选项
    anchor: { permalink: false },
    // markdown-it-toc 的选项
    toc: { includeLevel: [1, 2] },
    config: md => {
      // 使用更多的 markdown-it 插件!
      md.use(require('markdown-it-xxx'))
    }
  }
}