# ElixirNote Nbc

## TOC

* [Introduction](#introduction)
* [Installation](#installation)
* [Usage](#usage)
* [Examples](#examples)

## Introduction

The [nbconvert](https://github.com/ElixirNote/elixirnbc) 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

## Installation

```
pip instal elixir-nbc
```

## Usage

From the command line, use nbconvert to convert a Elixir 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 Jupyter notebook file, **`sample.ipynb`**, to HTML using:

```
elixir-nbconvert --to html sample.ipynb
```

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

## Examples

### Example 01

### Example 02