Crate jotdown

A pull parser for Djot.

The main entry is through Parser which implements an Iterator of Events. The events can then be used to traverse the document structure in order to e.g. construct an AST or directly generate to some output format. This crate provides an html module that can be used to render the events to HTML.

Feature flags

• html (default): build the html module and a binary that converts djot to HTML.

Examples

Generate HTML from Djot input:

use jotdown::Render;
let djot_input = "hello *world*!";
let events = jotdown::Parser::new(djot_input);
let mut html = String::new();
jotdown::html::Renderer::default().push(events, &mut html);
assert_eq!(html, "<p>hello <strong>world</strong>!</p>\n");

Apply some filter to a specific type of element:

let events =
    jotdown::Parser::new("a [link](https://example.com)").map(|e| match e {
        Event::Start(Link(dst, ty), attrs) => {
            Event::Start(Link(dst.replace(".com", ".net").into(), ty), attrs)
        }
        e => e,
    });
let mut html = String::new();
jotdown::html::Renderer::default().push(events, &mut html);
assert_eq!(html, "<p>a <a href=\"https://example.net\">link</a></p>\n");

Modules

• html
  An HTML renderer that takes an iterator of Events and emits HTML.

Structs

• AttributeValue
  Stores an attribute value that supports backslash escapes of ASCII punctuation upon displaying, without allocating.
• AttributeValueParts
  An iterator over the parts of an AttributeValue that should be displayed.
• Attributes
  A collection of attributes, i.e. a key-value map.
• OffsetIter
  An iterator that is identical to a Parser, except that it also emits the location of each event within the input.
• Parser
  A parser that generates Events from a Djot document.

Enums

• Alignment
  Alignment of a table column.
• Container
  A container that may contain other elements.
• Event
  A Djot event.
• LinkType
  The type of an inline link.
• ListKind
  The type of a list.
• OrderedListNumbering
  Numbering type of an ordered list.
• OrderedListStyle
  Style of an ordered list.
• SpanLinkType
  The type of an inline span link.

Traits

• Render
  A trait for rendering Events to an output format.