Skip to main content

Use Jupyter notebooks to publish with Hugo.

Project description

https://img.shields.io/pypi/v/hugo_jupyter.svg https://img.shields.io/travis/knowsuchagency/hugo_jupyter.svg Updates https://img.shields.io/github/license/mashape/apistatus.svg

Publish Jupyter notebooks with Hugo.

Installation

pip install hugo_jupyter

Usage

example_movie.gif
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.

http://i.imgur.com/ynQs0gB.png http://i.imgur.com/Jcjwc0y.png

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
hugo_jupyter-1.0.2-py2.py3-none-any.whl (11.6 kB) Copy SHA256 hash SHA256 Wheel 3.6 Oct 2, 2017
hugo_jupyter-1.0.2.tar.gz (201.5 kB) Copy SHA256 hash SHA256 Source None Oct 2, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page