jeereemiassb

Apps / Confluence

Notebook Viewer: Jupyter .ipynb Files for Confluence

Jupyter notebooks in your pages, with code, tables, charts and outputs.

Confluence CloudBuilt on ForgeRuns on Atlassian

Get it on the Atlassian Marketplace →

On this pageOverviewGetting startedMacro settingsMoving from Jupyter Notebook ViewerLimitationsPermissionsData and privacyTroubleshooting

Overview

Show Jupyter notebooks on Confluence pages as they look in Jupyter, so people who don't use Jupyter can read analyses and experiments where the team already works.

  • Markdown cells with headings, lists, tables, code, links and embedded images.
  • Code cells with syntax highlighting and In/Out execution numbers.
  • Outputs: text, pandas and other HTML tables, PNG, JPEG, GIF and SVG images, Markdown, JSON and errors without terminal colour codes.
  • Options to hide the code, the outputs or the execution numbers.
  • Notebook formats 4 and 3, from Python, R, Julia and other kernels.

Getting started

  1. A Confluence administrator installs the app from its Atlassian Marketplace listing.
  2. Attach the .ipynb file to the page.
  3. Edit the page, type /Jupyter Notebook and insert the macro. With no settings, it shows the first .ipynb attached.
  4. Publish the page.

Macro settings

SettingWhat it does
AttachmentOptional. The name of the notebook to show, when the page has more than one.
ShowCode and outputs (default), outputs only, or code only.
Execution numbersShow or hide In [1] and Out [1].

Moving from Jupyter Notebook Viewer

Atlassian ends support for Connect, the platform used by Jupyter Notebook Viewer, on 31 January 2027. This app is built on Forge and runs on Atlassian's cloud.

Existing macros of the other app are not converted automatically. For each page:

  1. Make sure the .ipynb file is attached to the page. If the old macro loaded it from a URL or a Git repository, download it and attach it.
  2. Type /Jupyter Notebook and insert the macro. Name the file in Attachment if the page has more than one notebook.
  3. Delete the old macro and publish.

Both apps can be installed at the same time, so you can try this one before you uninstall the other.

Other app names on this page are trademarks of their owners. This app is independent and is not affiliated with them.

Limitations

  • Notebooks up to 4 MB and 400 cells; clear large outputs in Jupyter to stay under the limit.
  • HTML outputs are shown as text, except tables. Interactive widgets are not shown.
  • LaTeX formulas are shown as code.
  • Notebooks from a URL or a Git repository are not supported: attach the file to the page.

Permissions

ScopeWhy
read:attachment:confluenceList the attachments of the page, as the person viewing it, to find the file.
readonly:content.attachment:confluenceDownload that file, as the person viewing the page.

No egress: the app does not connect to any server outside Atlassian.

Data and privacy

The app stores nothing. The notebook is read with the permissions of the person viewing the page and parsed in their browser. Nothing is logged and no data leaves Atlassian. See the privacy policy.

Troubleshooting

The macro says the page has no notebook

Attach the .ipynb file to the page, or name it in the macro settings.

The app says it needs an active license

The app is paid and checks the license on every request. Ask your site administrator to check the app's subscription in the administration of Jira or Confluence (Apps → Manage apps). During a free trial the app works normally.

Need help?

See the support page.