The GitHub integration allows you to preview live issue and pull request information from GitHub links in Outline documents. You can see the current status, timestamp, a preview of the description and labels associated with an issue. For pull requests the merge status is also displayed.

Config

To setup the integration navigate to Settings → Integrations → GitHub. You must have an admin role to be able to see this screen. Click the “Connect” button and authenticate with your GitHub account – you can also choose at this time if to only allow previewing specific repos or all repos in your GitHub organization.

Connect multiple organizations

If you have more than one GitHub organization it can be connected in the same way by navigating to the settings page and click on the “Connect” button that is now in the header.

Usage

Once the integration is connected, paste a github.com issue or pull request link into an Outline document and you will see the option to embed which displays detailed information inside the document.