GitHub Links for Confluence embeds live GitHub data directly on a Confluence page. Paste any supported GitHub URL and it automatically converts to a styled, real-time card - or add it manually using the macro editor.
Supported entities include: issues, pull requests, repositories, branches, source files, accounts, releases, milestones, commits, compare views, discussions, gists, blame views, tags, projects, wiki pages, and security alerts (Dependabot, Code Scanning, Security Advisories). See Supported GitHub link types for the full reference.
New to GitHub Links for Confluence? If you have not yet connected the app to your Confluence site, start with the Getting Started Guide for Confluence Administrators. If the app is already connected and you just want to get started quickly, see the Getting Started Guide for Confluence Users.
Method 1: Copy and paste a URL (recommended)
-
Copy a GitHub URL from your browser.
-
Open a Confluence page in edit mode.
-
Paste the URL - it converts automatically.
To keep the plain URL instead of converting it, press Ctrl+Z (Windows) or Cmd+Z (Mac) immediately after pasting.
Both https://github.com/... and https://{your-org}.ghe.com/... (GitHub Enterprise Cloud) URLs are supported.
Method 2: Insert via the macro editor
-
In the Confluence editor, type
/GitHub linksor click the + button and search for GitHub links.
-
The macro is inserted and the configuration panel opens.
-
In the GitHub Link field, paste the URL of the GitHub entity you want to display.
-
Set any additional options (see GitHub Links macro - configuration options).
-
Click Submit.
Updated: