How to add plugins

Integration with other services

GitBook is simple and good enough in its default setting, but it is configurable using plug-ins and APIs. The following only lists the integration that are currently set up with our books. To learn more see Developer Help Documentation.

Slack

• Mandatory for all client books
• The updates made to books and discussion are announced in Slack channel 'gitbook_webhook' automatically. This allows organisation members to confidently switch off the email notification. Go to Account Setting - Profile to opt out of receiving notification email from GitBook
• Currently only updates/merging send notification to Slack - this can be set in Book Settings - Webhooks
• Webhook is configured in Account Setting in Slack and Book Settings - Webhooks in GitBook
• Guide: https://github.com/GitbookIO/services-slack

Algolia

• Mandatory for all client books
• Algolia provides more accurate search results than default search engine
• Plug-in 'algolia' set up in book.json
• Private key from Algolia is entered in Book Settings - Options
• Free - may need to upgrade as the number of queries and records increase in the future
• Guide: https://plugins.gitbook.com/plugin/algolia

GitHub

• Only used for back-up; from GitBook exported to GitHub repo
• Full synchronisation can be done by setting up webhook if needed
• GitHub repository can be set up in Book Settings - GitHub
• Free
• Guide: https://help.gitbook.com/github/how-can-i-export-to-repo.html

Google Analytics

• Mandatory for all client books
• Google Analytics provides better insight into the audience than GitBook's Traffic feature
• Plug-in 'ga' set up in book.json
• Team account details
  • ID: [email protected]
  • Password: orgvue2016
• Go to https://analytics.google.com/ to view the traffic reports for Basic, Advanced and Gizmo Cookbook
• Free
• Guide: https://plugins.gitbook.com/plugin/ga

Other useful plug-ins

• expandable-chapters, collapsible-chapters, toggle-chapters: Collapse/ expand chapters on the side bar
• sectionx: Collapse / expande sections See instructions, See example
• youtube: Embed Youtube videos