Module: Ipynb2web:cli

The entry point for the CLI version of ipynb2web.

Install:

npm install ipynb2web

Usage:

ipynb2web <COMMAND> <SAVETO> <FROM/or/SitemapName>

Get help:

ipynb2web help

It provides a command line interface function that processes given arguments and calls createSitemap,
createAudio, or cli_nbs2html, based on the first argument.

Author:
  • Charles Karpati
Source:

Methods

(static) cli(args)

Command line interface function that processes given arguments and calls the appropriate function based on the first argument.

Parameters:
Name Type Description
args Array.<string>

An array of command line arguments.

  • args[0]: 'Command' - Enter ['sitemap', 'audio'] to create these assets. If neither, it will the value be appended to the SAVETO and FROM paths for processing nb2json on.
  • args[1]: 'SAVETO' - This directory path, used as a target directory for saving files.
  • args[2]: 'FROM' - This directory path, used as an output directory for processing files (Whenever args[0] is NOT 'sitemap').
  • args[2]: 'sitemapFile' - The file path for saving the sitemap (ONLY when args[0] is 'sitemap').
  • args[3]: 'pathPrefix' - Optional prefix to add to all URLs in the sitemap (ONLY when args[0] is 'sitemap').
Source:

(static) help()

Displays documentation on how to use the CLI when 'help' argument is provided.

Source: