Get started

Updated
View as text
Open in Confluence
Open in ChatGPT Open in Claude

Browse repositories, select files, and show Markdown, diagrams, images, and other files directly on your pages:

  • Insert Markdown from Git (richly rendered)

  • Insert Diagrams from Git (Mermaid, PlantUML, DOT, and more)

  • Insert Images from Git (PNG, JPG, SVG, etc.)

  • Insert Other Files from Git (code with syntax highlighting, config, markup, plain text)

Install Capable →

#How it works

  • Each person connects their own GitHub account. Access is never shared between people.

  • People only see a file if they have access to its repository, branch and file.

  • Your GitHub organisation may ask for approval or single sign-on (SSO). If it does, complete that step when prompted.

#Getting started

  1. Open a Confluence page, type /github and choose the Github file macro.

Confluence slash menu showing the Github File option, with slash github typed below
Type /github and pick Github File (Capable).

  1. Connect your GitHub account when prompted. Complete any organisation approval or SSO step if it is asked for.

  1. Pick a repository and branch, then select the file you want to show.

  1. Adjust the title or display options, then add it to your page.

Add to page dialog showing a Mermaid sequence diagram preview above a Title field
Check the preview, set a title, then press Add to page.

  1. That is it. The file now shows on your page.

Github file macro on a Confluence page showing a rendered sequence diagram
The finished macro. The repository path sits above the diagram, with open and refresh icons at the right.

#In this section

Common tasksThe 12 things people actually do with GitHub, and where each one lives.

Start from the task.