How to ☁️

Owned by Philippe Gadiou
Last updated: Oct 16, 2024
2 min read

You can include Notebooks from different sources (Confluence, Bitbucket Cloud, GitHub Cloud, Dropbox) in order to have an up-to-date version of it in a Confluence page. The macro will feature syntax highlighting for the included Notebook.

Include notebook from a Confluence page

  1. Type directly /Jupyter Viewer for Confluence and ENTER to add and edit the macro. Alternatively you can pick the Jupyter Viewer for Confluence macro from the macro browser.

  2. Type in the field the Confluence Page where the notebook is located (if the notebook is on the current page, go directly to next step)

  3. In the field Notebook Attachment field, select the notebook you want to include from the dropdown

Untitled design.gif

 

Include notebook from a notebook url (Bitbucket, GitHub, Dropbox)

  1. Paste the url of the Jupyter notebook in your Confluence page, the macro will automatically be added to render the notebook

Or

  1. Type directly /Jupyter Viewer for Confluence and ENTER to add and edit the macro. Alternatively you can pick the Jupyter Viewer for Confluence macro from the macro browser.

  2. Add the notebook URL

Notebooks from GitHub private repositories

For files that are within GitHub private repositories, users will need to authenticate to view the files' content. To do so, save a GitHub token in the Jupyter Viewer for Confluence admin configuration (go to Apps > Manage Apps > Jupyter Viewer for Confluence).

Once a token has been saved, the app will use the token for all GitHub requests.

Edit the macro

 Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro.