GitBook
Access documentation from GitBook
Availability depends on your school's enabled tools, provider setup, and account permissions. These settings are managed in the web workspace. A class policy may restrict a feature described here.
How it works#
The GitBook connector will pull in all the documentation content from your specified GitBook spaces.
Setting up#
Authorization#
Open Developer settings#
Go to your GitBook account settings and navigate to 'Developers' section (https://app.gitbook.com/account/developer)
Create API token#
Click on 'Create new token'. Give your token a name and select the appropriate scopes. Click 'Create' to generate your API token.
Copy and store token#
Copy and save your token securely. you won't be able to see it again.
Indexing#
Open GitBook connector#
Navigate to the Admin Panel and select the GitBook Connector
Enter API token#
In Step 1, paste your API Token from the previous step
Enter Space ID and connect#
Enter your Space ID - you can find this in the URL of your GitBook space (e.g.,
https://app.gitbook.com/o/<organization>/s/<space-id>). Click 'Connect' to begin indexing your GitBook content.
Before using this source with students#
Start with approved course material. Check which documents the connector can retrieve and how it maps source permissions. Test with a student account and a teacher account before widening access. A successful sync does not prove that the intended class boundary is correct.
Use source troubleshooting when a document is missing or visible to the wrong audience.