Struct HTMLRenderer 

pub struct HTMLRenderer { /* private fields */ }

Render an mdast tree or fragment as HTML.

This renders AST nodes directly. It is separate from crate::to_html, which renders Markdown source through the parser’s event compiler. Raw HTML is escaped and JSX is omitted by default; URLs use the same safe protocol allowlists as the built-in HTML compiler. Pass allow_dangerous_html to render raw HTML and static JSX. MDX expressions and ESM are omitted because evaluating JavaScript is outside the renderer’s scope.

Example

use socketry_markdown::{mdast::Headings, renderer::HTMLRenderer, to_mdast, ParseOptions};

let tree = to_mdast("# Hello *world*!", &ParseOptions::default())?;
let mut renderer = HTMLRenderer::default();
let html = tree.render_with(&mut renderer);

Implementations

impl HTMLRenderer

pub fn new() -> Self

Create a safe HTML renderer with default options.

pub fn with_options(options: CompileOptions) -> Self

Create an HTML renderer with compilation options.

pub fn options(&self) -> &CompileOptions

Return the options used by this renderer.

Trait Implementations

impl Clone for HTMLRenderer

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 HTMLRenderer

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

Formats the value using the given formatter.

impl Default for HTMLRenderer

fn default() -> Self

Returns the “default value” for a type.

impl Renderer for HTMLRenderer

fn render(&mut self, node: &Node) -> String

Render a node and its descendants.

fn render_node(&mut self, node: &Node) -> String

Render one AST node into this renderer’s output.

fn render_children(&mut self, node: &Node) -> String

Render the direct children of a parent node in order.