Struct Options 

pub struct Options {
    pub fragment: bool,
    pub stylesheet: Option<String>,
    pub body_suffix: String,
    pub icons: bool,
    pub highlight: bool,
    pub mermaid: bool,
    pub math: bool,
    pub copy: bool,
    pub toc_levels: Option<usize>,
    pub mark_reading: bool,
}

How the rendered body should be wrapped.

Fields

fragment: bool

Emit only the body content, with no surrounding HTML page.

stylesheet: Option<String>

CSS to embed in the page, or None for an unstyled page.

Ignored when fragment is set, since a fragment has no <head> to put it in.

body_suffix: String

Markup appended just before </body>, for scripts and the like.

Ignored when fragment is set, for the same reason.

icons: bool

Whether an admonition is marked with an icon rather than its label.

highlight: bool

Whether a source block is syntax highlighted.

A block still carries its language-… class either way, so a page can be highlighted in the browser instead.

mermaid: bool

Whether a mermaid block is drawn as a diagram, or left as the listing block it was written as.

math: bool

Whether an equation is converted to MathML, or left as the notation it was written in.

copy: bool

Whether a verbatim block is given a button that copies it to the clipboard.

The button is added by a small script the page carries, so a fragment never has one: the page it is embedded in owns what it loads.

toc_levels: Option<usize>

How deep the outline goes, overriding the document’s toclevels.

None leaves the depth to the document, which is what a standalone render wants. A host building a site has a site-wide default and its own name for the per-page override — Antora spells it page-toclevels — and has already resolved the two by the time it renders, so it says the answer rather than trying to write it back into the document.

mark_reading: bool

Whether the outline marks the entry for the section being read.

Beside a long document a docked outline can say where the reader is as well as what there is, which is the difference between a list of links and a sense of place. Like the copy button it is applied by a script the page carries, so a fragment never has it and a page with scripting switched off still gets an outline that works.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Options

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.