Module: Ipynb2web:node

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

Install:

npm install ipynb2web

Import using ESM:

import ipynb2web from 'ipynb2web';

Import using CJS:

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

Usage:

const prepairedJsonAsset = ipynb2web.nb2json(url)

Returns:

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

Calls core functionalities from the convert, prerender, convert_util modules.

Author:
  • Charles Karpati
Source:

Members

(static, 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

Calls prerender.createSitemap to create a sitemap.
createAudio function

Calls prerender.createAudio to create audio.
cli_nbs2html function

Calls prerender.cli_nbs2html to convert notebooks to HTML from command line.
createSpeech function

Calls create_audio.createSpeech to create speech.
saveSpeech function

Calls create_audio.saveSpeech to save speech.
getTextFromJson function

Calls create_audio.getTextFromJson to get text from JSON.
speechFromDir function

Calls create_audio.speechFromDir to create speech from a directory.
makeDetails function

Calls convert_util.makeDetails to make details.
replaceEmojis function

Calls convert_util.replaceEmojis to replace emojis.
convertNotes function

Calls convert_util.convertNotes to convert notes.
replaceAndLog function

Calls convert_util.replaceAndLog to replace and log.
nb2json function

Calls convert.nb2json to convert Jupyter Notebook to JSON.
Source: