# 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          | [Embed a GitHub file in Confluence](https://help.gocapable.com/git/embed-a-github-file-in-confluence.html)                                                        |
| Show a README or other Markdown as formatted text | [Show a GitHub README in Confluence](https://help.gocapable.com/git/show-a-github-readme-in-confluence.html)                                                      |
| Draw a Mermaid, PlantUML or draw.io file          | [Show a diagram from GitHub in Confluence](https://help.gocapable.com/git/show-a-diagram-from-github-in-confluence.html)                                          |
| Pin a file to a release tag or another branch     | [Show a GitHub file from a branch, tag or commit in Confluence](https://help.gocapable.com/git/show-a-github-file-from-a-branch-tag-or-commit-in-confluence.html) |
| Know every setting the macro has                  | [Github file](https://help.gocapable.com/git/github-file.html)                                                                                                    |
| Know which pasted links turn into the macro       | [Auto-convert pasted GitHub links](https://help.gocapable.com/git/auto-convert-pasted-github-links.html)                                                          |
| Check file types and size limits                  | [Limits](https://help.gocapable.com/git/limits.html)                                                                                                              |

---

## 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.](https://help.gocapable.com/git/embed-a-github-file-in-confluence.html)[Show a GitHub README in ConfluenceShow a repository's README.md on a Confluence page as formatted text that stays in step with GitHub.](https://help.gocapable.com/git/show-a-github-readme-in-confluence.html)[Show a diagram from GitHub in ConfluenceDraw a Mermaid, PlantUML, draw.io or other diagram file kept in GitHub on a Confluence page.](https://help.gocapable.com/git/show-a-diagram-from-github-in-confluence.html)[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.](https://help.gocapable.com/git/show-a-github-file-from-a-branch-tag-or-commit-in-confluence.html)

---

## Related

### [GitHub sign-in and permissions in Confluence](https://help.gocapable.com/git/github-sign-in-and-permissions-in-confluence.html)

Connecting accounts and who sees what.

### [Finding and fixing GitHub embeds](https://help.gocapable.com/git/finding-and-fixing-github-embeds.html)

Find pages and fix broken embeds.

### [GitHub for Confluence FAQ](https://help.gocapable.com/git/github-for-confluence-faq.html)

Short answers to common questions.

---

_One source of truth, shown where people read._