HTML

Publish amazing graphics for discovery that otherwise get shared once & then go unused sitting on random local file servers around the business!

You can easily share HTML files on Kyso, where they are indexed for search and discovery. There are two kinds of HTML-based reports to consider.

Single-page HTML

Publishing HTML files is pretty straightforward. Simply configure your report's metadata, setting the HTML file as the "main" variable in the YAML header, and then publish! You can do this with the CLI tool OR simply upload the files in the browser:

pageCreating Reports In-App

Note that you can "Open in Full Screen" on these report files to get that full HTML experience in the browser!

Open HTML in full screen!

If possible, don't edit the HTML file name, since this can impact the styling of the rendered report (example border overflow). HTML reports on Kyso are simply embedded iframes.

Full Websites

There is a little more to publishing full websites over simple, single-page HTML files. For this doc, we'll use Jupyter Books as an example. But do note that Kyso will render any website.

Since websites entail publishing not just one file, but many, potentially with lots of other accompanying files & sub-folders, users should publish these to Kyso using the CLI tool.

1. Jupyter Books

A Jupyter Book is compiled to HTML from multiple Jupyter Notebooks, with optional JS and/or CSS styling. See Jupyter's gallery for examples:

https://executablebooks.org/en/latest/gallery.html​

We cover the basics of Jupyter Book creation in this document. Please refer to the official Jupyter documentation for more robust information on creating your Book reports:

https://jupyterbook.org/en/stable/intro.html

Installation

First you need to install the jupyter-book package. You can install Jupyter Book via pip:

// pip install -U jupyter-book

or via conda-forge:

// conda install -c conda-forge jupyter-book

This will install everything you need to build a Jupyter Book locally.

Build your book's HTML

Once you’ve added content (notebooks) and configured your book, it’s time to build outputs for your book.

You can use the jupyter-book build command line tool for this. You should already have a collection of notebook/Markdown files in your mybookname/ folder, a _toc.yml file that defines the structure of your book, and any configuration you’d like in the _config.yml file.

Now that your book’s content is in your book folder and you’ve defined your book’s structure in _toc.yml, you can build the HTML for your book. Do so by running the following command:

// jupyter-book build mybookname/

This will generate a fully-functioning HTML site using a static site generator. The site will be placed in the _build/html folder, something like this:

mybookname
 └──_build
    └── html
       ├── _images
       ├── _static
       ├── index.html
       ├── intro.html
       ...

You can now publish to Kyso. Make sure you specify the main file in the reports YAML, for example:

main: _build/html/index.html