返回介绍

Markdown 扩展

发布于 2019-05-30 13:40:05 字数 2980 浏览 1213 评论 0 收藏 0

标题锚点(header anchors)

标题会自动获取锚点链接。可以使用 markdown.anchor 选项来配置锚点的渲染。

链接(links)

内部链接(internal links)

.md.html 结尾的内部链接,会被转换为 <router-link>,用于单页面应用程序(SPA)导航。

静态网站的每个子目录都应该包含一个 README.md。这个文件会自动转换为 index.html

提示

在编写「链接到某个目录下 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 目录下的 README.md 发送给用户 -->
[foo 标题锚点](/foo/#heading) <!-- 跳转到 foo 目录下的 README.md 文件中的特定锚点位置 -->
[foo - one](/foo/one.html) <!-- 追加 .html -->
[foo - two](/foo/two.md) <!-- 或者追加 .md -->

外部链接(external links)

外部链接会被自动地设置为 target="_blank" rel="noopener noreferrer"

  • vuejs.org
  • VuePress on GitHub

你可以自定义通过配置 config.markdown.externalLinks 来自定义外部链接的特性。

Front Matter

提供开箱即用的 YAML front matter:

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

数据在页面的其余部分也可以使用,包括所有自定义和主题组件,通过 $page 访问。

titlelang 会在当前页面自动设置。另外,你可以指定额外的 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 风格的表格

输入

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

输出

TablesAreCool
col 3 isright-aligned$1600
col 2 iscentered$12
zebra stripesare neat$1

Emoji

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文