Input: Yuque Repo, Output: VuePress Site!
Branch: master
Clone or download
Latest commit 450ecf1 Feb 14, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.media chore: add hero image Feb 8, 2019
docs/.vuepress chore: tweak hero image Feb 8, 2019
example/.vuepress chore: disable html for example Feb 8, 2019
lib fix($core): cannot use correct api base url for custom yuque domain Feb 14, 2019
test first commit Feb 4, 2019
.editorconfig first commit Feb 4, 2019
.gitattributes first commit Feb 4, 2019
.gitignore ci: fix deploy failed Feb 7, 2019
.release-it.json ci: setup release Feb 7, 2019
CHANGELOG.md 0.3.1 Feb 14, 2019
LICENSE first commit Feb 4, 2019
README.md chore: readme Feb 9, 2019
package.json 0.3.1 Feb 14, 2019
yarn.lock chore: remove resolutions Feb 11, 2019

README.md

vuepress-plugin-yuque

NPM version NPM downloads CircleCI

本插件需要 VuePress >= 1.0.0-alpha.37

特性

  • 简单:Zero-Markdown,只需配置你的语雀 repo 地址,就能获得一个 VuePress 站点;
  • 高效:自动生成的文档主页、侧边栏让你享受 “高效” 的文档生成体验;
  • 缓存:完美地解决语雀 Open API 调用次数超限的问题;

想了解更多,请移步:

快速上手

在 VuePress 中配置 repoUrl

// .vuepress/config.js
module.exports = {
  title: 'Ant Design 实战教程',
  description: '基于 umi 的 Ant Design 实战教程',
  plugins: [
    ['vuepress-plugin-yuque', {
      repoUrl: 'https://www.yuque.com/ant-design/course',
    }]
  ]
}

你就能获得这个Site,更多使用方法,可参见文档

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

vuepress-plugin-yuque © ULVIZ, Released under the MIT License.
Authored and maintained by ULVIZ with help from contributors (list).

github.com/ulivz · GitHub @ULVIZ · Twitter @_ulivz