From 9879ecee707f43baa21307b8fe0a36c5e4f0d131 Mon Sep 17 00:00:00 2001 From: Keith Date: Fri, 26 May 2017 17:04:38 -0600 Subject: [PATCH] updated readme --- README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) diff --git a/README.md b/README.md index e69de29..4ab4427 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,49 @@ +# Being More Productive with Jupyter Notebooks: An Introduction to NBExtensions + +This talk is about how to get the most out of the [NBExtensions]() feature of Jupyter Notebooks. + +NBExtensions provide an array of interesting functionality to Jupyter and this talk touches on a few of them, including + +* gist-it +* table of contents +* spell checker, +* and others + +The original talk was presented on April 21, 2017 by me (myself and I) to the [CU Boulder Computational Science and Engineering Research Group](https://www.meetup.com/University-of-Colorado-Computational-Science-and-Engineering/events/239108756/). + +## Installing the talk + +This talk was originally written as a Jupyter notebook and the HTML file for the talk is using [reveal.js](). + +To convert the talk to HTML you will need to run: +``` +jupyter nbconvert nbextensions_talk.ipynb --to slides --reveal-prefix "http://cdnjs.cloudflare.com/ajax/libs/reveal.js/3.3.0" +``` + +## Viewing the talk + +While the source for the talk is provided here, you do not need to convert it unless you need to make modifications to it. + +To view the talk, simply clone this repository and view the original HTML source in any browser here: + +[Original source HTML](./slides.slides.html) + +The example file that shows a few of these extensions at work can be found in the notebook: + +[Example notebook showing extensions at work](./example_document.ipynb) + +OR as HTML + +[HTML-converted example notebook showing extensions at work](./example_document.html) + +## Resources + +Installing NBExtensions can be found here: + +[https://github.com/ipython-contrib/jupyter_contrib_nbextensions](https://github.com/ipython-contrib/jupyter_contrib_nbextensions) + +And the convenience of installing the plugin configurator can be found here: +[https://github.com/Jupyter-contrib/jupyter_nbextensions_configurator](https://github.com/Jupyter-contrib/jupyter_nbextensions_configurator) + +The complete instructions and project documentation should be consulted to install properly. +