Include from GitHub to Confluence
Breadcrumbs

Include directory ☁️

You can include at once all the files of a specific directory (folder) from a GitHub repository in your Confluence page.


Add the macro

You can add the macro either by:

  • typing directly /Github Directory and ENTER to add and edit the macro.

  • using the Insert button from the editor toolbar and then picking the GitHub Directory macro from the “External Content” category of the macro library.

You will then be prompted to specify the following:

URL

URL of the directory in a GitHub repository

Syntax highlighting

Format/ language for highlighting purposes (auto detect is performed by default)

Show line number

Tick to display number of lines in the file

Hide file header

Tick to hide file headers when files are rendered

Collapsible

Collapses the file content and gives the option to expand and collapse

Include GitHub Cloud - add directory macro gif.gif


For directories that are within private repositories, users will need to authenticate to view the files' content. More information in this section.