/cocos-gitbook-plugin-github-issue-feedback

GitHub issue feedback/bug report for gitbook.

Primary LanguageJavaScriptMIT LicenseMIT

gitbook-plugin-github-issue-feedback

GitHub issue feedback for gitbook.

gitbook-plugin-github-issue-feedback-language

  • add language support

gitbook-plugin-github-issue-feedback-language-custom

  • add disable feedback button support on smartphone
  • change button content to "提交反馈", when reading Chinese books
  • language config maybe "zh" or "zh-hans" for Chinese, make folder path always "zh"

Install

Install with npm:

npm install gitbook-plugin-github-issue-feedback

Usage

You should set repo in your book.json.

book.json

  • repo: owner/name
{
    "gitbook": ">=3.0.0",
    "title": "Example",
    "plugins": [
        "github-issue-feedback"
    ],
    "pluginsConfig": {
        "github-issue-feedback": {
            "repo": "azu/gitbook-plugin-github-issue-feedback"
        }
    }
}

Changelog

See Releases page.

Running tests

Install devDependencies and Run npm test:

npm i -d && npm test

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.

  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

License

MIT © azu