配置

repoUrl

  • 类型: string
  • 默认值: undefined

要构建的语雀知识库的地址,如你现在看到的文档的 repoUrl :

module.exports = {
 plugins: [
   ['vuepress-plugin-yuque', {
     repoUrl: 'https://www.yuque.com/vuepress/vuepress-plugin-yuque',
   }]
 ]
} 

repoId

  • 类型: string|number
  • 默认值: undefined

如果你知道一个知识库的特定 id(如本文档的 id:214564),你也可以直接设置此选项。注意:此选项将覆盖 repoUrl

module.exports = {
 plugins: [
   ['vuepress-plugin-yuque', {
     repoId: '214564',
   }]
 ]
} 

home

  • 类型: object
  • 默认值: {}

参见: 生成主页

html

  • 类型: string
  • 默认值: false

设置成 true 的话,VuePress 内部的 markdown 解析器会去解析 markdown source 中的 HTML tag,请注意,这并不安全!因为存在潜在的 XSS 风险。

此外,当你的 markdown source 中存在  HTML 时,VuePress 会尝试去解析 HTML 树,所以请确保你的 markdown source 中不包含未闭合的双闭合标签。如果你想要以阻止其被 VuePress 解析以显示原始的 HTML tag ,请用 inline code (`)将其包裹起来。



使用语雀查看