gitbook-plugin-github-search

gitbook-search

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.

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
  • 1.0.8 adapt to header's height
  • 1.0.9 remove unused dependencies

⛽ How to contribute

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

📜 License

MIT © aleen42