Show a GitHub README in Confluence

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

To show a GitHub README in Confluence, insert the Markdown (Capable) macro, choose Markdown from URL and paste the repository or file link as you see it in your browser. Capable turns it into the raw file address for you, renders it as GitHub would, and shows the latest version of the file whenever the page loads.

#Before you start

  • You need permission to edit the page.

  • The file must be reachable without signing in. A file in a private repository will not load.

  • GitHub, GitLab and Bitbucket links are converted automatically. Any other address must return the raw Markdown text.

#Steps

  1. Copy the link: the repository home page for its README, a branch page, or a single file.

  2. In the Confluence editor, type /markdown and choose Markdown (Capable), or Markdown macro (Capable) in the standalone app.

  3. In Configure Markdown, choose Markdown from URL.

  4. Paste the link into the URL field and wait for the preview to load.

  5. Click Save, then publish the page.

#What happens next

A link to a repository such as github.com/owner/repo shows README.md from the default branch. A branch link shows that branch's README.md, and a file link shows that file. The page follows the file, so changes pushed to the repository appear on the page without editing it.

#If it does not work

  • The preview says to make sure the URL returns raw text. The address returns a web page, not the file. Use a GitHub, GitLab or Bitbucket file link, or the file's raw address.

  • It works for you but not for a colleague, or nothing loads. Check the repository is public. Capable fetches the file through its own service, without your sign-in.

One README, one source of truth, shown where people look.