Crate dmos

A Djot renderer with advanced features.

DMOS builds on the jotdown Djot parser and its default HTML renderer, but adds the following features:

• Syntax highlighting (if enabled, see feature flags)
• Table of contents generation with various options
• Adding anchors to section headings

The main entry points are the module’s render(), title() and toc() functions. See RenderOpts and TocOpts for options controlling the output. For more low-level customizations, the individual renderers could also be used, but make sure to use the re-exported jotdown module when working with them.

Feature flags

• syntect (default): syntax highlighting for code block based on syntect
• inkjet: syntax highlighting based on inkjet

Re-exports

• pub use jotdown;

Structs

• DocumentRenderer
  Implementation of jotdown::Render that renders documents with advanced features.
• RenderOpts
  Options controlling the document generation.
• TitleRenderer
  Implementation of jotdown::Render that only writes a document’s plain-text title.
• TocOpts
  Options controlling the table-of-contents generation.
• TocRenderer
  Implementation of jotdown::Render that renders a document’s table of contents as HTML.

Enums

• Error

Functions

• render
  Renders a Djot document to HTML.
• title
  Returns the plain-text title of the document.
• toc
  Renders a table of contents for the document as HTML.