gitbook-plugin-github-search

    1.0.7 • Public • Published

    gitbook-search

    npm javascript gitbook gitbook

    A Gitbook plugin to implement searching with GitHub Search API, and means that you need to deploy your Gitbook repository on GitHub before using this plugin.

    github-search

    Installation

    Add the following plugins to your book.json and run the command gitbook install

    {
       "plugins": ["github-search"]
    }

    Usage

    Because it is based on GitHub Search API, you may need to provide an access token to avoid request limitations.

    {
       "plugins": [
          "github-search"
       ],
       "pluginsConfig": {
          "github-search": {
             "repo": "aleen42/PersonalWiki",
             "token": "YOUR_GITHUB_ACCESS_TOKEN"
          }
       }
    }

    TODO

    • [ ] Implement pagination
    • [ ] User experience enhancement
    • [ ] Responsive design for mobile devices

    Release History

    • ==================== 1.0.0 Initial release ====================
      • 1.0.1 Temporarily hide when using mobile devices
      • 1.0.4 Fix some problems
        • Remove anchor outline
        • Wrong anchor path
      • 1.0.6 Base64 encode the token to avoid the detection of GitHub
      • 1.0.7 style enhancement

    How to contribute

    Have an idea? Found a bug? See how to contribute.

    📜 License

    MIT © aleen42

    Keywords

    Install

    npm i gitbook-plugin-github-search

    DownloadsWeekly Downloads

    7

    Version

    1.0.7

    License

    MIT

    Unpacked Size

    562 kB

    Total Files

    7

    Last publish

    Collaborators

    • aleen42