ipynb2html-core

This package provides the converter itself and some utilities withno dependencies.You have to provide your own syntax highlighter and Markdown, math and ANSI sequences renderer; or not, if you don’t need them.

ipynb2html

This package builds on the ipynb2html-core and provides a complete, ready-to-go renderer configured with:

• marked as Markdown renderer,

• KaTeX as math renderer,

• anser as ANSI sequences renderer,

• highlight.js as syntax highlighter.

It also provides a reference stylesheet which you can find indist/notebook.min.css (or non-minifiedstyles/notebook.css).

ipynb2html-cli

This package provides a CLI interface for ipynb2html.

Standalone CLI Tool

ipynb2html-cli is also provided as a single minified JavaScript with all the external dependencies bundled in.It requires only Node.js (version 10 or newer) to be installed on the system.

• ipynb2html-cli-v0.4.0-rc.1.tar.gz

• ipynb2html-cli-v0.4.0-rc.1.zip

The archive also contains source maps (useful for debugging).

If you useAlpine Linux, you can also install it from packageipynb2html.

CLI

Runipynb2html --help for more information.

Node.js (server-side)

To render HTML in Node.js (server-side rendering), you need some (fake) DOM implementation.The recommended one isnodom — it’s lightweight,small, doesn’t have any external dependencies and ipynb2html is tested against it.However, you can choose any other if you like.

Browser (client-side)

You have basically two options how to use ipynb2html in the browser: use the browser bundles provided in the ipynb2html package, or build your own bundle (using e.g.Rollup orwebpack).

The provided bundles are in UMD format (AMD, CommonJS and IIFE in one file), so they should work in all environments (old and modern browsers, Node.js).They are transpiled and have injectedcore-js polyfills to be compatible with browsers that have>0.5% global coverage, Firefox ESR, and not dead browsers.

System Requirements

• NodeJS 10.13+

• Pandoc andAsciidoctor (used only for converting README.adoc to Markdown for npmjs)

Used Tools

• TypeScript the language

• ttypescript wrapper fortsc allowing to use custom AST transformers

• yarn for dependencies management and building

• ESLint for linting JS/TypeScript code

• Jest for testing

• Rollup for building single-file bundles

How to Start

1. Clone this repository:

   git clone https://github.com/jirutka/ipynb2html.git

2. Install Yarn (if you don’t have it already):

   npm install -g yarn

3. Install all JS dependencies:

   yarn install

4. Build the project:

   yarn build

5. Run tests and generate code coverage:

   yarn test

6. Run linter:

   yarn lint

Visual Studio Code

If you use Visual Studio Code, you should install the following extensions:

• Coverage Gutters

• EditorConfig for VS Code

• ESLint

• Jest (andJest Snippets Standard Style)

• yarn