Connect with Github

Owned by Aljoša Klišanić
Last updated: Jan 09, 2024
1 min read

The Mermaid Diagrams for Confluence cloud add-on features a GitHub integration with repository explorer UI. Note that DC version does not have this feature. This allows users to use Mermaid diagrams stored in their GitHub repositories within their Confluence cloud instance.

The add-on uses GitHub OAuth application to access your files. We recommend customers use dedicated GitHub account with proper permissions to connect with the GitHub application. This is important because repository access is done on the GitHub side.

GitHub connection is done in 3 simple steps:

  1. Create add-on Settings Space using the Configuration page.

  2. On the same page, initiate GitHub connection flow(see image below).

  3. Connect your account with the GitHub app and return to Confluence.

GitHub Authorization popup

After successful integration, Mermaid diagrams can be displayed on Confluence pages and blog posts by the add-on.

Error messages

Access key is expired or invalid

User needs to generate new access key. Go to Settings page and remove current key by clicking on “Disconnect GitHub Account“ button. Then connect as before. You will be granted new valid key.