Expand description
Re-exports§
pub use extensions::Extension;pub use extensions::Extensions;pub use extensions::presets;pub use media::MediaBag;pub use media::MediaItem;
Modules§
- container
container - Packaging primitives shared by container-based document formats.
- extensions
- Format extensions: the set of optional syntax features a reader or writer may honor.
- media
- The media bag: a document’s embedded resources — images and other binary payloads — carried alongside the syntax tree rather than inside it.
- sections
- Section numbering and table-of-contents construction over the document model.
- template
template - A small string-template engine: variables, conditionals, loops, pipes, and partials over a
Valuecontext. The language uses$-delimited directives; seeparsefor the grammar and the surrounding module docs for whitespace handling. - walk
- Mutable traversals over the document model.
Structs§
- Epub
Options - Options for the EPUB container writer. Ignored by every other writer. The default is an empty book: no cover, no embedded fonts, the built-in stylesheet only, and chapters split at the top heading level.
- Reader
Options - Options controlling a
Reader. Extended (not resignatured) as real options land. - Writer
Options - Options controlling a
Writer. Extended (not resignatured) as real options land.
Enums§
- AnyReader
- A resolved reader, either text-shaped (
Reader) or byte-shaped (BytesReader). - AnyWriter
- A resolved writer, either text-shaped (
Writer) or byte-shaped (BytesWriter). - Error
- The error type returned across the conversion pipeline.
- Math
Method - How math is presented by a format that offers a choice of renderers (the HTML family). The
method decides both the inline markup inside a
span.mathand which loader a standalone document pulls in to typeset it: a MathJax (or plain) document carries the source TeX wrapped in\(…\)/\[…\], whereas a KaTeX document carries the bare TeX, which its in-browser loader reads from the span directly. - Meta
VarStyle - Which plain-text identity variables a writer’s standalone template draws on. The document’s
title, authors, and date are exposed as markup-free, target-escaped text for places that cannot
carry markup — a web document head or a PDF document’s properties. See
Writer::meta_var_style. - Output
- The output of a conversion: text from a text writer, bytes from a byte-shaped writer.
- TocStyle
- How a writer supplies a table of contents.
- Wrap
Mode - How a text writer lays out the lines of a paragraph.
Traits§
- Bytes
Reader - Parses input bytes in some source format into the document model. The byte-shaped counterpart of
Reader, for formats whose wire form is not text — zip containers and the like. - Bytes
Writer - Renders the document model into some target format’s bytes. The byte-shaped counterpart of
Writer, for formats whose output is not text — zip containers and the like. - Reader
- Parses input text in some source format into the document model.
- Writer
- Renders the document model into some target format’s text.