PDF

Although the main goal of this project is to have a beautiful HTML reports, there is also support for PDF reports.

There are two methods of generating PDF report: HTML with browser export and PDF via Latex.

PDF from HTML

The first way of generating PDF is the following:

Generate HTML report.
Open it in your browser.
Export it to PDF from the browser (Ctrl + P).

To improve the output PDF styles, we should disable the dynamic elements that have no meaning in the result PDF. The next code block demonstrates, which settings we should focus on.

output:
    html:
        toc: false
        tabset: false
        code_folding: disable

Important

This is the recommended way of generating markdown.

PDF via Latex

Warning

Generating PDF via Latex is experimental.

We can also export PDF via Latex. This can be done by the following command:

jupyter nbconvert --to html --template pj-pdf /path/to/ipynb/file

To use this, we need to have pandoc installed. To install pandoc on Linux, you can generally use package manager:

sudo apt-get install pandoc

On other platforms, you can get pandoc from their website.

Note

To provide custom overrides for metadata, instead of --HtmlNbMetadataPreprocessor, we need to use --NbMetadataPreprocessor.

The export can be customized by overriding values in pdf section of the metadata configuration. Check out Notebook-Level Metadata for more information.

Examples

Check out our example repository for this and more examples. Specifically:

pdf: Shows, how pdf looks when generated directly (via pandoc) or indirectly via html.