How to make polished Jupyter presentations with optional code visibility

Jupyter notebooks are great because they allow you to easily present interactive figures. In addition, these notebooks include the figures and code in a single file, making it easy for others to reproduce your results. Sometimes though, you may want to present a cleaner report to an audience who may not care about the code. This blog post shows how to make code visibility optional, and how to remove various Jupyter elements to get a clean presentation.

On the top is a typical Jupyter presentation with code and some extra elements. Below that is a more polished version that removes some of the extra elements and makes code visibility optional with a button.

To make the code optionally visible, available at the click of a button, include a raw cell at the beginning of your notebook containing the JavaScript and HTML below. This code sample is inspired by a Stack Overflow post, but makes a few improvements such as using a raw cell so that the button position stays fixed, changing the button text depending on state, and displaying gradual transitions so the user understands what is happening.

<script> function code_toggle () { if ( code_shown ){ $ ( ' div.input ' ). hide ( ' 500 ' ); $ ( ' #toggleButton ' ). val ( ' Show Code ' ) } else { $ ( ' div.input ' ). show ( ' 500 ' ); $ ( ' #toggleButton ' ). val ( ' Hide Code ' ) } code_shown = ! code_shown } $ ( document ). ready ( function (){ code_shown = false ; $ ( ' div.input ' ). hide () }); </script> <form action= "javascript:code_toggle()" ><input type= "submit" id= "toggleButton" value= "Show Code" ></form>

It’s pretty straightforward to remove the extra elements like the header, footer, and prompt numbers. That being said, you may want to still include some attribution to the Jupyter project and to your free hosting service. To do all of this, just include a raw cell at the end of your notebook with some more JavaScript.

<script> $ ( document ). ready ( function (){ $ ( ' div.prompt ' ). hide (); $ ( ' div.back-to-top ' ). hide (); $ ( ' nav#menubar ' ). hide (); $ ( ' .breadcrumb ' ). hide (); $ ( ' .hidden-print ' ). hide (); }); </script> <footer id= "attribution" style= "float:right; color:#999; background:#fff;" > Created with Jupyter, delivered by Fastly, rendered by Rackspace. </footer>

One shortcoming with what we have so far is that users may still see some code or other unwanted elements while the page is loading. This can be especially problematic if you have a long presentation with many plots. To avoid this problem, add a raw cell at the very top of your notebook containing a preloader. This example preloader includes an animation that signals to users that the page is still loading. It heavily inspired by this preloader created by @mimoYmima.

<script> jQuery ( document ). ready ( function ( $ ) { $ ( window ). load ( function (){ $ ( ' #preloader ' ). fadeOut ( ' slow ' , function (){ $ ( this ). remove ();}); }); }); </script> <style type= "text/css" > div #preloader { position : fixed ; left : 0 ; top : 0 ; z-index : 999 ; width : 100% ; height : 100% ; overflow : visible ; background : #fff url('http://preloaders.net/preloaders/720/Moving%20line.gif') no-repeat center center ; } </style> <div id= "preloader" ></div>

To work with these notebooks, you can clone my GitHub repository. While the notebooks render correctly on nbviewer (unpolished, polished), they do not render correctly on the GitHub viewer.

Please enable JavaScript to view the comments powered by Disqus.