Jekyll Jupyter Notebook plugin
Ruby Jupyter Notebook HTML
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
doc/text Add 0.0.3 entry Mar 31, 2018
docs Add "example" Apr 27, 2017
example Use iframe to embed notebook Mar 31, 2018
lib Bump version Mar 31, 2018
.gitignore Add note for kramdown users Apr 27, 2017
.yardopts Import Apr 27, 2017
Gemfile Import Apr 27, 2017
LICENSE Import Apr 27, 2017
NOTICE.txt Import Apr 27, 2017
README.md Use "plugins" instead of deprecated "gems" Mar 31, 2018
Rakefile Disable test task Jul 18, 2017
jekyll-jupyter-notebook.gemspec Import Apr 27, 2017

README.md

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