- 介绍
- 起步
- 配置
- 静态资源处理
- Markdown 扩展
- 在 Markdown 中使用 Vue
- 自定义主题
- 国际化支持(internationalization)
- 部署
- 基本配置(basic config)
- 主题化(theming)
- Markdown
- 建立管道(build pipeline)
- 浏览器兼容性(browser compatibility)
- 主页(homepage)
- 导航栏(navbar)
- 侧边栏(sidebar)
- 搜索框(search box)
- 最近更新
- Service Worker
- 上一页 / 下一页链接(prev / next links)
- Git 仓库和编辑链接
- 简单的 CSS 覆盖
- 自定义页面的 class
- 特定页面的自定义布局(custom layout for specific pages)
- 弹出(ejecting)
文章来源于网络收集而来,版权归原创者所有,如有侵权请及时联系!
Markdown 扩展
标题锚点(header anchors)
标题会自动获取锚点链接。可以使用 markdown.anchor
选项来配置锚点的渲染。
链接(links)
内部链接(internal links)
以 .md
或 .html
结尾的内部链接,会被转换为 <router-link>
,用于单页面应用程序(SPA)导航。
静态网站的每个子目录都应该包含一个 README.md
。这个文件会自动转换为 index.html
。
提示
在编写「链接到某个目录下 index.html
」的相对路径时,不要忘记在结尾用 /
闭合,否则你将得到一个 404。例如,使用 /config/
而不是 /config
。
如果你想要链接到另一个 markdown 文件,记得:
- 在链接后面添加
.html
或.md
- 确保大小写对应正确,因为路径匹配是区分大小写的
示例
给定以下目录结构:
.
├─ 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
访问。
title
和 lang
会在当前页面自动设置。另外,你可以指定额外的 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 |
输出
Tables | Are | Cool |
---|---|---|
col 3 is | right-aligned | $1600 |
col 2 is | centered | $12 |
zebra stripes | are neat | $1 |
Emoji
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论