# GitHub integration

> Where the world builds software

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

![GitHub Outline Integration](https://www.getoutline.com/images/integrations/screenshots/github.png)

### Setup

To setup the integration navigate to [Settings → Integrations → GitHub](https://app.getoutline.com/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 whether to allow previewing specific repositories or all repositories in your GitHub organization.

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

> Note: GitHub is linked once for the entire Outline workspace, other team members will be able to see issue and pull request details from repositories that are linked in this way.

### 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 "mention" it, which displays detailed information inside the document. You can also hover over any linked issue or pull request to see more details.

Mentions stay automatically up-to-date as the issue or pull request changes on GitHub.