NBfancy Tutorial

This tutorial explains how to use NBfancy to generate and build your own courses.

The first half covers the core features:

  • Motivation for using NBfancy
  • Installation
  • Typical Build Process
  • File structure
  • Environments
  • Using git and remote builds

The second half covers more advanced use:

  • Multi-cell environments
  • Defining your own keywords
  • Making your own templates
  • Magic
  • Slides
  • Contributing

Prerequisites:

To get the best out of NBfancy you should be comfortable using:

  • Jupyter notebooks
  • A python package manager such as pip or conda
  • The command line
  • Git

The more advanced usage require slightly more in-depth knowledge of the above.

Schedule:

Core features

Time Episode Description
0:00 Motivation Why use NBfancy?
0:10 Installation Install NBfancy
0:20 Build A typical build process
0:30 File Structure File structure for lessons
0:40 Environments Additional keywords
0:50 Git and CI Automate hosted lessons

Advanced topics

Time Episode Description
1:00 Multicell Multiple cell environments
1:10 Keywords Defining keywords
1:20 Template Defining templates
1:30 Magic Extra magic in NBfancy
1:40 Slides Presenting with NBfancy
1:50 Contributing Contributing to NBfancy

Setup:

The setup for NBfancy is covered in Installation.