How do I get Github to embed in a Confluence page

Trena Norcia August 5, 2021

We need Github when added to a Confluence page to be embedded.  When you clicking the Github icon in the article it opens in a new browser the expanded source file.   

What do I need to have it embed in the article in Confluence?

 

github embedded.JPG

Thanks

3 answers

1 vote
Sue Rocha_Mibex Software_ March 29, 2023

Hello @Trena Norcia,

You may find Include GitHub for Confluence Cloud useful for your use case where you want to embed a GitHub source file into Confluence.

You can simply copy the URL of the GitHub file and paste it into the Confluence page.

In the following example we use this GitHub URL of a .js file:

4ce71a2f-9539-4c3e-a68a-f1b714147d46.png

Then paste the URL in the Confluence file as shown in the video and the macro will automatically be applied to embed the file.

include-github-file-gif (1).gif

Also, we have just launched Include GitHub for Confluence DC in the marketplace.  It can be used to render public and private files from both GitHub Enterprise and GitHub.com.

I hope this is helpful.

Best regards,
Sue from Mibex Software

1 vote
Daniel Eads
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
August 6, 2021

Hi @Trena Norcia ,

Confluence Cloud's native smart link functionality might help out here. When you drop a link into the editor, you might notice it changes from a raw URL into a nicely formatted page title:

image.png

If you select this link in the editor, you can change its display style:

image.png

The "Display as card" option will expand out a bit and show some extra information. For pull requests, it will at least include the summary:

image.png

 

Some types of content such as gists will also have a "Display embed" option, which can give you the whole content right on the Confluence page:

image.png

And you'll also notice that the "Display embed" option gives you the resize handles, as well as lets you wrap text around the embed if you'd like to.

Cheers,
Daniel

Andrew Grossman January 6, 2023

@Daniel Eads What are the Confluence requirements to get the display options shown above? I am working out of a Confluence cloud instance and do not have that "Display" dropdown available. The link I'm trying to embed is to a source file with a line marker in GitHub.

 

image.png

Like # people like this
Michael Kamprath
I'm New Here
I'm New Here
Those new to the Atlassian Community have posted less than three times. Give them a warm welcome!
February 15, 2023

Same here.

Clare Warden
I'm New Here
I'm New Here
Those new to the Atlassian Community have posted less than three times. Give them a warm welcome!
October 9, 2023

Has anyone received a response here? We're also not getting this option.

Piotr Boho
I'm New Here
I'm New Here
Those new to the Atlassian Community have posted less than three times. Give them a warm welcome!
January 25, 2024

I quess if repository is not public then there is no option to reveal data

S Irvine February 6, 2024

I do not see any dropdown as shown above.

JoEllen Carter March 7, 2024

Also would like to do this.  I see everything except the embed option.

Like Joe_Noel likes this
0 votes
Kishan Sharma
Community Leader
Community Leader
Community Leaders are connectors, ambassadors, and mentors. On the online community, they serve as thought leaders, product experts, and moderators.
August 5, 2021

Hi Trena, are you using any plugin already of plan to install one ? There are plenty of plugins available to achieve this. Refer this article.

Suggest an answer

Log in or Sign up to answer
DEPLOYMENT TYPE
CLOUD
PRODUCT PLAN
STANDARD
PERMISSIONS LEVEL
Site Admin
TAGS
AUG Leaders

Atlassian Community Events