Getting Started Guide for Confluence Users

GitHub Links for Confluence lets you embed live GitHub data directly on any Confluence page - no switching tabs, no copying and pasting stale screenshots.

What you can embed

Paste any GitHub URL and it automatically converts to a real-time card. Supported entity types include:

• Issues and issue lists

• Pull requests and PR lists

• Repositories

• Branches

• Source files and source file line ranges

• Accounts and profiles

• Releases and release lists

• Milestones

• Tags

• Commits and commit lists

• Compare views (branch diffs)

• Discussions and discussion lists

• Gists (with line range support)

• Blame views

• Projects

• Wiki pages

• Dependabot alerts, Code Scanning alerts, and Security Advisories

Both GitHub.com and GitHub Enterprise Cloud (*.ghe.com) URLs are supported. See Supported GitHub link types for the full reference.

How to add a GitHub link to a page

Option 1: Paste directly (recommended)

1. Copy a GitHub URL from your browser.

   

2. Open a Confluence page in edit mode.

3. Paste the URL - it converts automatically.

   

To keep the plain URL without converting, press Ctrl+Z / Cmd+Z immediately after pasting.

Option 2: Use the macro editor

1. In the Confluence editor, type /GitHub links or click + and search for GitHub links.

   

2. Paste your GitHub URL into the GitHub Link field.

3. Configure display options as needed.

4. Click Submit.

Use cases

• Writing informative technical Confluence documentation with GitHub data

• Preparing sprint retrospectives

• Documenting release details

Updated: 12 Jun 2026