Vue GitHub Buttons
GitHub buttons component for Vue.
Installation
Via NPM:
Via Yarn:
Usage
Using with Nuxt
Add vue-github-buttons/nuxt
to modules
in nuxt.config.js.
Module options
css
Type: Boolean
Default: true
Include Vue GitHub Buttons's CSS.
useCache
Type: Boolean
Default: true
Enable caching. (See below)
Using with VuePress
Require VuePress v1.x
Add Vue GitHub Buttons to your plugins
in .vuepress/config.js
.
Plugin options are the same as Vue plugin options.
API
Plugin Options
useCache
Type: Boolean
Default: true
Enable count number caching. (Use session storage)
GitHub API has limited requests. So, caching may be useful when user refresh the webpage.
Components
gh-btns-watch
?️ A watch button.
slug
- GitHub slug (username/repo).show-count
- Enable displaying the count number.
gh-btns-star
⭐ A star button.
slug
- GitHub slug (username/repo).show-count
- Enable displaying the count number.
gh-btns-fork
? A fork button.
slug
- GitHub slug (username/repo).show-count
- Enable displaying the count number.
gh-btns-follow
? A follow button.
user
- GitHub username.show-count
- Enable displaying the count number.