Skip to content

red-data-tools/jekyll-jupyter-notebook

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README

Name

Jekyll Jupyter Notebook plugin

Description

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

Install

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

Usage

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}

Authors

License

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.)