Skip to content

ElixirNote/elixirnbc

Repository files navigation

ElixirNBC

Google Group Build Status Documentation Status Documentation Status codecov.io

The nbconvert tool, elixir nbconvert, converts notebooks to various other formats via Jinja templates. The nbconvert tool allows you to convert an .ipynb notebook file into various static formats including:

  • HTML
  • LaTeX
  • PDF
  • Reveal JS
  • Markdown (md)
  • ReStructured Text (rst)
  • executable script

Usage

From the command line, use nbconvert to convert a Jupyter notebook (input) to a a different format (output). The basic command structure is:

$ elixir-nbconvert --to <output format> <input notebook>

where <output format> is the desired output format and <input notebook> is the filename of the Jupyter notebook.

Convert notebook file, sample.ipynb, to HTML using:

$ elixir-nbconvert --to html sample.ipynb

This command creates an HTML output file named mynotebook.html.

Dev Install

Check if pandoc is installed (pandoc --version); if needed, install:

sudo apt-get install pandoc

Or

brew install pandoc

Install elixirnbc for development using:

git clone git@github.com:ElixirNote/elixirnbc.git
cd elixirnbc
pip install -e .

Documentation

Technical Support

  • Issues and Bug Reports: A place to report bugs or regressions found for nbconvert
  • Community Technical Support and Discussion: A place for installation, configuration, and troubleshooting assistannce by the Elixir community. As a non-profit project and maintainers who are primarily volunteers, we encourage you to ask questions and share your knowledge on Discourse.