Skip to main content

generate_html

html_generator::generator

Function generate_html 

Source 
pub fn generate_html(markdown: &str, config: &HtmlConfig) -> Result<String>
Expand description

Generate HTML from Markdown content using mdx-gen.

This function takes Markdown content and a configuration object, converts the Markdown into HTML, and applies the full processing pipeline based on configuration:

  1. Markdown → HTML conversion (with extensions)
  2. Accessibility: adds ARIA attributes if enabled
  3. Table of contents: injects TOC at [[TOC]] placeholder
  4. Structured data: appends JSON-LD script tag
  5. Minification: compresses output if enabled

Non-fatal failures in steps 2–5 are silently skipped. Use generate_html_with_diagnostics to inspect which steps failed.

§Examples

use html_generator::{generator::generate_html, HtmlConfig};

let html = generate_html("# Hello", &HtmlConfig::default()).unwrap();
assert!(html.contains("<h1>Hello</h1>"));

§Errors

Returns crate::error::HtmlError if the core Markdown→HTML conversion fails (input invalid, exceeds buffer limits, etc.).