Getting Started

About

Ipynb2web is designed to convert Interactive Python Notebooks (.ipynb) into web-ready, static assets that are template-compatible. This standalone tool uses marked as it's only dependency and offers unique functionalities not found in other tools like Pandoc, Sphinx, Nbdev, Quarto, etc.

Complete with API documentation, this project facilitates seamless integration of .ipynb documents into web formats.

Core Features

1. Inclusion of yaml metadata at the top of notebooks for processing instructions in the final json output.
2. Use of special #flags to control output formatting for individual notebook cells.
3. Option to add minimally opinionated, pre-formatted content through specific markup.

Capabilities

1. Converts .ipynb documents into web-templatable json assets with a single command.
2. Enables rendering of assets on the server or browser using Modules, Vanilla JS, or terminal commands.
3. Supports custom template creation and integration with existing tools.
4. Automates handling of intricate details overlooked by other notebook conversion tools, such as removing system logs, warnings, and error messages.
5. On the server side, it can traverse directories to create python modules, tables of contents, sitemaps, cover photos, and audio transcriptions.

Development Notes

1. Running Build will link/relink the repo to your global npm registry
2. Rendered JSDocs are inserted as static asseets into Docsaurus.
3. The node module does not get minified but served directly from source. BuildESM is not used.