2.1.7 HTML5 Renderer Options

Each renderer can define its own configuration options. This section describes options from the HTML5 renderer. These options have no effect if another renderer is used. Also these options may have no effect if the default theme is not used.

The first three options give control on navigation helpers (tables of contents and breadcrumbs links). Together with the extra-css option, which allows to set css rules overriding the default ones, they allow radical changes to the output style without modifying any template or python code. See Section 5.5 for more information on the HTML5 renderer and how to customize its output.

Display table of contents on each page

Command-Line Options: --display-toc or --no-display-toc
Config File: [ html5 ] display-toc
Default: true
specifies whether to display the table of contents on each page.

Local table of contents level

Command-Line Options: --localtoc-level=level
Config File: [ html5 ] localtoc-level
Default: Node.DOCUMENT_LEVEL-1
specifies from which level one creates local table of contents. The default value implies local table of contents are never created.

Create breadcrumbs from this level

Command-Line Options: --breadcrumbs-level=level
Config File: [ html5 ] breadcrumbs-level
Default: -10
specifies from which level one creates breadcrumbs navigation links.

Use theme CSS

Command-Line Options: --use-theme-css or --no-theme-css
Config File: [ html5 ] use-theme-css
Default: True
specifies whether to use CSS files from the theme.

Theme CSS file

Command-Line Options: --theme-css=theme
Config File: [ html5 ] theme-css
Default: green
specifies when CSS theme to use. Possible values are currently blue or green.

Extra CSS file

Command-Line Options: --extra-css=filename1, ...
Config File: [ html5 ] extra-css
Default: ”
specifies a comma separated list of css files to use in addition the theme css. These files are copied to the output directory by the renderer and loaded by the main layout template in the list order after the theme css files (if any) and the packages css files (if any).

Use theme javascript

Command-Line Options: --use-theme-js or --no-theme-js
Config File: [ html5 ] use-theme-js
Default: True
specifies whether to use javascript files from the theme. The default theme javascript is used to hide or show part of the table of contents and proofs.

Extra javascript

Command-Line Options: --extra-js=filename1, ...
Config File: [ html5 ] extra-css
Default: ”
specifies a comma separated list of javascript files to use (in addition to those coming from the theme is the use-theme-js option is set to true). These files are copied to the output directory by the renderer and loaded by the main layout template in the list order after the theme javascript files (if any) and the packages javascript files (if any).

Use MathJax

Command-Line Options: --use-mathjax or --no-mathjax
Config File: [ html5 ] use-mathjax
Default: True
specifies whether to use MathJax for mathematics rendering. Setting this to False only makes sense if the document contains no mathematics or if some filter is expected to handle mathematics (see --filters option below).

MathJax library url

Command-Line Options: --mathjax-url=url
Config File: [ html5 ] mathjax-url
Default: http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_CHTML
specifies where to find the MathJax javascript lib (including the config information as in the default value).

Use single dollars as math delimiter for MathJax

Command-Line Options: --dollars or --no-dollars
Config File: [ html5 ] mathjax-dollars
Default: False
specifies whether single dollars are used as math delimiters instead of \( and \). This information is used by MathJax.

Filters applied on output

Command-Line Options: --filters=filter1, …
Config File: [ html5 ] filters
Default: ”
specifies a comma separated list of commands to invoke on each output page. Each command should expect one file to convert on stdin and output the converted file on stdout.

TikZ compiler

Command-Line Options: --tikz-compiler=compiler
Config File: [ html5 ] tikz-compiler
Default: ’pdflatex’
specifies which program to use for compiling tikz pictures before conversion to svg and inclusion in the html file. See Section .

TikZ converter

Command-Line Options: --tikz-converter=converter
Config File: [ html5 ] tikz-converter
Default: ’pdf2svg’
specifies which program to use for converting tikz pictures pdf files to svg before inclusion in the html file. See Section .

TikZ template

Command-Line Options: --tikz-template=template_file
Config File: [ html5 ] tikz-template
Default: ”
specifies a file containing a tex template for tikz pictures compilation. See Section .

TikZ-CD template

Command-Line Options: --tikz-cd-template=template_file
Config File: [ html5 ] tikz-cd-template
Default: ”
specifies a file containing a tex template for tikz-cd diagrams compilation. See Section .