Installation

pip install hugo_jupyter

Usage

cd root_of_hugo_project
hugo_jupyter --init

This will create a notebooks directory at the root of your hugo project if it doesn’t yet exist. Any jupyter notebooks you want rendered should go in the notebooks directory.

In addition, a fabfile.py script will be written at the project root.

fab serve

Automatically initializes your jupyter server, hugo server, and watchdog to re-render your jupyter notebooks to markdown for hugo as you create and edit them.

Jupyter Notebooks

Any notebooks that you create will need front matter for hugo to know how to render the content.

Once you edit the name of the jupyter notebook to something other than Untitled*.ipynb, hugo-jupyter will automatically edit the notebook’s metadata to enable rendering with jupyter. You may need to reload the notebook page to see the changes in the metadata.

There will also be a hugo-jupyter dictionary in the notebook’s metadata with a render-to field automatically set to content/post/. You can edit this field to edit where the notebook’s markdown will be rendered to.

Any other fields you add to front-matter (author, tags, thumbnail, …) are passed through to the rendered post.

Plots and other image outputs are written to static/notebooks/<slug>/ and linked from the post as /notebooks/<slug>/....

Hugo’s default markdown renderer drops raw HTML, which hides HTML outputs such as pandas tables. To show them, add this to your hugo config:

[markup.goldmark.renderer]
  unsafe = true

hugo_jupyter --init copies fabfile.py into your project, so re-run it after upgrading hugo_jupyter to pick up fixes.