Content with notebooks

You can also create content with Jupyter Notebooks. The content for the current page is contained in a Jupyter Notebook in the notebooks/ folder of the repository. This means that we can include code blocks and their outputs, and export them to Jekyll markdown.

You can find the original notebook for this page at this address

Markdown + notebooks

As it is markdown, you can embed images, HTML, etc into your posts!

You an also and

But make sure you $Escape $your $dollar signs $you want to keep!

Code blocks and image outputs

Jupyter Book will also embed your code blocks and output in your book. For example, here's some sample Matplotlib code:

from matplotlib import rcParams, cycler
import matplotlib.pyplot as plt
import numpy as np
plt.ion()

# Fixing random state for reproducibility
np.random.seed(19680801)

N = 10
data = [np.logspace(0, 1, 100) + np.random.randn(100) + ii for ii in range(N)]
data = np.array(data).T
cmap = plt.cm.coolwarm
rcParams['axes.prop_cycle'] = cycler(color=cmap(np.linspace(0, 1, N)))


from matplotlib.lines import Line2D
custom_lines = [Line2D([0], [0], color=cmap(0.), lw=4),
                Line2D([0], [0], color=cmap(.5), lw=4),
                Line2D([0], [0], color=cmap(1.), lw=4)]

fig, ax = plt.subplots(figsize=(10, 5))
lines = ax.plot(data)
ax.legend(custom_lines, ['Cold', 'Medium', 'Hot']);

Note that the image above is captured and displayed by Jekyll.

You can also pop out content to the side!. For more information on how to do this, check out the customizing page layout page.

Removing content before publishing

You can also remove some content before publishing your book to the web. For example, in the original notebook there used to be a cell below...

You can also remove only the code so that images and other output still show up.

Below we'll only display an image. It was generated with Python code in a cell, which you can see in the original notebook

And here we'll only display a Pandas DataFrame. Again, this was generated with Python code from this original notebook.

	Word A	Word B
0	hi	there
1	this	is
2	a	DataFrame

You can configure the text that Textbooks with Jupyter uses for this by modifying your book's _config.yml file.

Interactive outputs

We can even do the same for interactive material. Below we'll display a map using ipyleaflet. When the notebook is converted to Markdown, the code for creating the interactive map is retained.

Note that this will only work for some packages. They need to be able to output standalone HTML/Javascript, and not depend on an underlying Python kernel to work.

import folium

m = folium.Map(
    location=[45.372, -121.6972],
    zoom_start=12,
    tiles='Stamen Terrain'
)

folium.Marker(
    location=[45.3288, -121.6625],
    popup='Mt. Hood Meadows',
    icon=folium.Icon(icon='cloud')
).add_to(m)

folium.Marker(
    location=[45.3311, -121.7113],
    popup='Timberline Lodge',
    icon=folium.Icon(color='green')
).add_to(m)

folium.Marker(
    location=[45.3300, -121.6823],
    popup='Some Other Location',
    icon=folium.Icon(color='red', icon='info-sign')
).add_to(m)


m

Rich outputs from notebook cells

Because notebooks have rich text outputs, you can store these in your Jupyter Book as well!

!jupyter-book create -h

usage: jupyter-book [-h] [--out-folder OUT_FOLDER] [--license LICENSE]
                    [--content-folder CONTENT_FOLDER] [--toc TOC]
                    [--config CONFIG] [--custom-css CUSTOM_CSS]
                    [--custom-js CUSTOM_JS]
                    [--extra-files EXTRA_FILES [EXTRA_FILES ...]]
                    [--overwrite] [--demo] [--verbose VERBOSE]
                    name

Create a new Jupyter Book

positional arguments:
  name                  The name of your Jupyter Book (your book template will
                        be placed in a folder of this name)

optional arguments:
  -h, --help            show this help message and exit
  --out-folder OUT_FOLDER
                        The location where your book will be placed
  --license LICENSE     A path to a LICENSE.md file if you have already
                        created one
  --content-folder CONTENT_FOLDER
                        A path to a folder that holds your book content
  --toc TOC             A path to a yaml file that contains a Table of
                        Contents for your Jupyter Book. This will overwrite
                        parts of the book template's default toc.yml
                        configuration
  --config CONFIG       A path to a configuration YAML file that contains
                        configuration for your Jupyter Book. This will
                        overwrite parts of the book template's default
                        _config.yml configuration
  --custom-css CUSTOM_CSS
                        A path to a CSS file that defines some custom CSS
                        rules for your book
  --custom-js CUSTOM_JS
                        A path to a JS file that defines some custom CSS rules
                        for your book
  --extra-files EXTRA_FILES [EXTRA_FILES ...]
                        A list of extra files / folders to copy into your
                        book's directory
  --overwrite           Whether to overwrite a pre-existing book if it exists
  --demo                Whether to build the book with demo content instead of
                        your own content
  --verbose VERBOSE     Whether to display output information. [yes/no]

this_will_error

---------------------------------------------------------------------------
NameError                                 Traceback (most recent call last)
<ipython-input-1-09f61459889d> in <module>()
----> 1 this_will_error

NameError: name 'this_will_error' is not defined