https://github.com/red-data-tools/jekyll-jupyter-notebook

Jekyll Jupyter Notebook plugin
https://github.com/red-data-tools/jekyll-jupyter-notebook

Last synced: about 2 months ago
JSON representation

Jekyll Jupyter Notebook plugin

• Host: GitHub
• URL: https://github.com/red-data-tools/jekyll-jupyter-notebook
• Owner: red-data-tools
• License: other
• Created: 2017-04-27T13:39:41.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-04-07T21:08:37.000Z (6 months ago)
• Last Synced: 2024-07-23T06:29:17.709Z (about 2 months ago)
• Language: Ruby
• Homepage: https://red-data-tools.github.io/jekyll-jupyter-notebook/
• Size: 162 KB
• Stars: 159
• Watchers: 8
• Forks: 27
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# README

## Name

Jekyll Jupyter Notebook plugin

## Description

Jekyll Jupyter Notebook plugin adds [Jupyter](http://jupyter.org/) Notebook support to Jekyll. You can embed Jupyter Notebooks into your texts.

## Install

Add the following line to your site's `Gemfile`:

```ruby

gem "jekyll-jupyter-notebook"

```

Run the following command line to make the gem available:

```console

% bundle install

```

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

```yaml

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:

```text

.

|-- my-text.md

`-- sample.ipynb

```

Put the following tag into the target text:

```markdown

{% 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:

```markdown

{::nomarkdown}

{% jupyter_notebook "sample.ipynb" %}

{:/nomarkdown}

```

## Configurations

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

```yaml

jupyter_notebook:

  # ...

```

### `prompt`

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

```yaml

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`:

```yaml

jupyter_notebook:

  prompt: false

```

## Authors

* Kouhei Sutou \

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