Embedding GitHub files in Confluence
Documentation goes stale the moment it is copied out of the repository. Embedding the file instead keeps one source of truth: the page shows whatever is on GitHub now, and nobody has to remember to paste the update.
Everything here uses one macro, Github file (Capable). Pick a guide for what you want on the page.
#Common tasks
You want to | Go to |
|---|---|
Put any file from a repository on a page | |
Show a README or other Markdown as formatted text | |
Draw a Mermaid, PlantUML or draw.io file | |
Pin a file to a release tag or another branch | Show a GitHub file from a branch, tag or commit in Confluence |
Know every setting the macro has | |
Know which pasted links turn into the macro | |
Check file types and size limits |
#Guides in this section
Embed a GitHub file in ConfluencePut a file from a GitHub repository on a Confluence page with the Github file macro, by picking it or pasting its link.Show a GitHub README in ConfluenceShow a repository's README.md on a Confluence page as formatted text that stays in step with GitHub.Show a diagram from GitHub in ConfluenceDraw a Mermaid, PlantUML, draw.io or other diagram file kept in GitHub on a Confluence page.Show a GitHub file from a branch, tag or commit in ConfluencePin a GitHub file on a Confluence page to a branch, tag or commit by pasting a link that names it.
#Related
One source of truth, shown where people read.
