Jekyll Jupyter Notebook plugin

Jekyll Jupyter Notebook plugin adds Jupyter Notebook support to Jekyll. You can embed Jupyter Notebooks into your texts.

Add the following line to your site's Gemfile:

gem "jekyll-jupyter-notebook"

Run the following command line to make the gem available:

% bundle install

Add the following line to your site's _config.yml:

plugins:
 - jekyll-jupyter-notebook

Put a Jupyter Notebook (sample.ipynb) to the directory that has the target text (my-text.md) like the following:

.
|-- my-text.md
`-- sample.ipynb

Put the following tag into the target text:

{% jupyter_notebook "sample.ipynb" %}

If you use kramdown as Markdown parser and get strange result, try to surround {% jupyter_notebook ...%} with {::nomarkdown} and {:/nomarkdown} like the following:

{::nomarkdown}
{% jupyter_notebook "sample.ipynb" %}
{:/nomarkdown}

You can customize .ipynb to .html conversion by jupyter_notebook in _config.yml:

jupyter_notebook:
 # ...

You can control whether a converted .html includes In [N]/Out[N] prompts or not by prompt:

jupyter_notebook:
 prompt: true

The default value is true. It means that In [N]/Out[N] are shown.

You can remove them by using false:

jupyter_notebook:
 prompt: false

Similar to how prompt works, you can also control whether a converted .html includes code inputs or not by using input:

jupyter_notebook:
 input: true

The default value is true. It means that input code blocks are shown.

You can remove them by using false:

jupyter_notebook:
 input: false

• Kouhei Sutou <kou@clear-code.com>

Apache License 2.0. See doc/text/apache-2.0.txt and NOTICE.txt for details.

(Kouhei Sutou has a right to change the license including contributed patches.)