Module: node

The entry point for the Node version of ipynb2web when installed via NPM.

Install:

npm install ipynb2web

Import using ESM:

// import { ipynb2web } from './../src/node.js';
// or
import ipynb2web from './../src/node.js';

Import using CJS:

// const ipynb2web = require('../dist/ipynb2web.cjs').default;
// or
const { ipynb2web } = require('../dist/ipynb2web.cjs');

Usage:

const prepairedJsonAsset = ipynb2web.nb2json(url)

Returns:

{ meta: { ... }, content: { ... } }

It exposes core functionalities from the convert, prerender, convert_util modules.

Author:
  • Charles Karpati
Source:

Members

(inner, constant) ipynb2web :Object

ipynb2web's Node implementation. This is not the same as the browser or the CLI implementation.

Type:
  • Object
Properties:
Name Type Description
createSitemap function

Function to create a sitemap.

createAudio function

Function to create audio.

cli_nbs2html function

Function to convert notebooks to HTML from command line.

createSpeech function

Function to create speech.

saveSpeech function

Function to save speech.

getTextFromJson function

Function to get text from JSON.

speechFromDir function

Function to create speech from directory.

makeDetails function

Function to make details.

replaceEmojis function

Function to replace emojis.

convertNotes function

Function to convert notes.

replaceAndLog function

Function to replace and log.

nb2json function

Function to convert Jupyter Notebook to JSON.

Source: