https://github.com/rokid/gitbook-plugin-vistors-github
Github Vistors Plugin for Gitbook
https://github.com/rokid/gitbook-plugin-vistors-github
Last synced: over 1 year ago
JSON representation
Github Vistors Plugin for Gitbook
- Host: GitHub
- URL: https://github.com/rokid/gitbook-plugin-vistors-github
- Owner: rokid
- Created: 2018-01-08T09:01:32.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-01-08T09:44:10.000Z (over 8 years ago)
- Last Synced: 2025-02-01T08:48:23.775Z (over 1 year ago)
- Language: JavaScript
- Size: 1.95 KB
- Stars: 1
- Watchers: 19
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GitBook-Plugin-Vistors-GitHub
The GitHub Vistors Plugin for Gitbook. This plugin creates requests to corresonding GitHub source
page when from HTML documentation.
### Installation
```sh
$ npm install gitbook-plugin-vistors-github --save
```
### Usage
Add the following config in your `book.json`
```json
{
"plugins": [
"vistors-github"
],
"pluginsConfig": {
"vistors-github": {
"repo": "...",
"branch": ""
}
}
}
```
Under the `pluginsConfig.vistors-github`, the following properties:
- `repo`: What repository on GitHub do you want to redirect, like "Rokid/docs".
- `branch`: What branch name on specified `repo` do you want to redirect, default is "master".
### License
MIT