How to 🗄️

You can include Notebooks from different sources (Confluence, Bitbucket Cloud, Bitbucket DC, GitHub, 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 attachment 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

Include notebook from a notebook url (Bitbucket Cloud, 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

Include notebook from a Bitbucket Data Center / Server repository

You need to have an application link to your Bitbucket Data Center instance configured to include a notebook hosted on this instance. More details in the installation 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. Under c) Bitbucket server file, select the relevant:

   1. Bitbucket instance

   2. Bitbucket project

   3. Bitbucket repository

   4. Repository branch

   5. File path

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.