返回介绍

Git 仓库和编辑链接

发布于 2019-05-30 21:56:09 字数 854 浏览 1189 评论 0 收藏 0

提供 themeConfig.repo 会在导航栏中自动生成一个 GitHub 链接,并在每个页面的底部显示「编辑此页面」链接。

// .vuepress/config.js
module.exports = {
  themeConfig: {
    // 假定 GitHub。也可以是一个完整的 GitLab URL。
    repo: 'vuejs/vuepress',
    // 自定义项目仓库链接文字
    // 默认根据 `themeConfig.repo` 中的 URL 来自动匹配是 "GitHub"/"GitLab"/"Bitbucket" 中的哪个,如果不设置时是 "Source"。
    repoLabel: '贡献代码!',

    // 以下为可选的 "Edit this page" 链接选项

    // 如果你的文档和项目位于不同仓库:
    docsRepo: 'vuejs/vuepress',
    // 如果你的文档不在仓库的根目录下:
    docsDir: 'docs',
    // 如果你的文档在某个特定的分支(默认是 'master' 分支):
    docsBranch: 'master',
    // 默认为 false,设置为 true 来启用
    editLinks: true,
    // 自定义编辑链接的文本。默认是 "Edit this page"
    editLinkText: '帮助我们改进页面内容!'
  }
}

你还可以通过 YAML front matter 隐藏指定页面上的编辑链接:

---
editLink: false
---

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

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

发布评论

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