Struct ToMarkdown 

pub struct ToMarkdown {
    pub document: bool,
    pub newlines: bool,
    pub checked: Option<String>,
    pub unchecked: Option<String>,
    pub quotes: Option<Vec<String>>,
    pub math: bool,
    pub code_meta: BTreeMap<String, String>,
}

html.toMarkdown: hast into mdast; options named as hast-util-to-mdast names them.

Fields

document: bool

Wrap all phrasing content of the root in paragraphs, as for a whole document.

newlines: bool

Collapse whitespace holding a line ending to that line ending instead of a space.

checked: Option<String>

The text of a checked checkbox or radio, [x] by default.

unchecked: Option<String>

The text of an unchecked checkbox or radio, [ ] by default.

quotes: Option<Vec<String>>

The quotes <q> uses, an opening and closing character each, alternating by how deep it nests; " by default.

math: bool

Turn MathML <math> holding a TeX annotation, as html.katex writes it, into math nodes, $…$ once md.math writes them, display math for display="block", and drop KaTeX’s visual katex-html copy.

code_meta: BTreeMap<String, String>

Attributes of a code block’s <pre> or <code> written into its meta, each to the key it takes there: {"data-title": "title"} makes title="a.js".

Trait Implementations

impl Clone for ToMarkdown

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 ToMarkdown

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

Formats the value using the given formatter.

impl Default for ToMarkdown

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ToMarkdown

where ToMarkdown: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Plugin for ToMarkdown

fn attach(&self, context: &mut Attach) -> Result<(), Error>

impl Transform for ToMarkdown

fn input(&self) -> TreeKind

fn output(&self) -> TreeKind

fn run<'a>( &self, tree: Tree<'a>, _file: &mut File, alloc: &'a Allocator, ) -> Result<Tree<'a>, Error>

fn start<'a>( &self, tree: Tree<'a>, file: &mut File, alloc: &'a Bump, ) -> Result<Step<'a>, Error>

Start the stage: a finished tree, or a job when its work is asynchronous.

fn host(&self) -> Option<u32>

The id of the binding function this stage stands for, which takes and returns whatever tree reaches it; None for a stage the crate runs.

fn html_writer(&self, _target: HtmlTarget) -> Option<Box<dyn HtmlWriter>>

Something that writes, from this stage’s input, the HTML a compiler aiming at target would write from its output, when the stage can skip building that tree.