html-generator 0.0.5

A robust Rust library designed for transforming Markdown into SEO-optimized, accessible HTML. Featuring front matter extraction, custom header processing, table of contents generation, and performance optimization for web projects of any scale.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

// SPDX-License-Identifier: Apache-2.0 OR MIT
// Copyright (c) 2025 HTML Generator. All rights reserved.

//! Full pipeline: every processing stage enabled in a single pass.
//!
//! Demonstrates ARIA injection, TOC generation, JSON-LD structured
//! data, and HTML minification working together.
//!
//! Run: `cargo run --example pipeline`

#[path = "support.rs"]
mod support;

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

fn main() {
    support::header("html-generator -- pipeline");

    let markdown = "\
[[TOC]]\n\n\
# Introduction\n\n\
Welcome to the guide.\n\n\
## Getting Started\n\n\
Follow these steps.\n\n\
## Advanced Usage\n\n\
For power users.\n";

    // ── Full pipeline (all features) ────────────────────────────────
    support::task_with_output(
        "Generate with all features enabled",
        || {
            let config = HtmlConfig {
                add_aria_attributes: true,
                generate_toc: true,
                generate_structured_data: true,
                minify_output: true,
                ..HtmlConfig::default()
            };
            let html = generate_html(markdown, &config).unwrap();
            vec![
                format!("length    = {} bytes", html.len()),
                format!("has_toc   = {}", html.contains("<ul>")),
                format!("has_aria  = {}", html.contains("aria-")),
                format!("has_jsonld = {}", html.contains("ld+json")),
            ]
        },
    );

    // ── Pipeline with diagnostics ───────────────────────────────────
    support::task_with_output(
        "Pipeline with diagnostics inspection",
        || {
            let config = HtmlConfig {
                add_aria_attributes: true,
                generate_toc: true,
                generate_structured_data: true,
                minify_output: true,
                ..HtmlConfig::default()
            };
            let output =
                generate_html_with_diagnostics(markdown, &config)
                    .unwrap();
            let mut lines = vec![
                format!("html_len    = {} bytes", output.html.len()),
                format!("diagnostics = {}", output.diagnostics.len()),
            ];
            for d in &output.diagnostics {
                lines.push(format!("  {d}"));
            }
            lines
        },
    );

    // ── Full HTML5 document output ────────────────────────────────
    support::task_with_output("Generate full HTML5 document", || {
        let config = HtmlConfig {
            generate_full_document: true,
            generate_structured_data: true,
            language: "en-US".into(),
            ..HtmlConfig::default()
        };
        let html = generate_html(markdown, &config).unwrap();
        vec![
            format!(
                "has <!DOCTYPE>  = {}",
                html.contains("<!DOCTYPE html>")
            ),
            format!(
                "has lang=en-US  = {}",
                html.contains("lang=\"en-US\"")
            ),
            format!("has <head>      = {}", html.contains("<head>")),
            format!("has <body>      = {}", html.contains("<body>")),
            format!("has ld+json     = {}", html.contains("ld+json")),
        ]
    });

    // ── Sanitized HTML mode ─────────────────────────────────────────
    support::task_with_output(
        "Sanitize unsafe HTML via ammonia",
        || {
            let unsafe_md = "# Title\n\n<script>alert('xss')</script>\n\n<div class=\"safe\">Allowed</div>";
            let config = HtmlConfig {
                allow_unsafe_html: true,
                sanitize_html: true,
                ..HtmlConfig::default()
            };
            let html = generate_html(unsafe_md, &config).unwrap();
            vec![
                format!(
                    "has <script>    = {}",
                    html.contains("<script>")
                ),
                format!("has <div>       = {}", html.contains("<div")),
                format!(
                    "script stripped = {}",
                    !html.contains("<script>")
                ),
            ]
        },
    );

    // ── Minimal pipeline (defaults) ─────────────────────────────────
    support::task_with_output(
        "Default config (syntax highlighting only)",
        || {
            let html = generate_html(markdown, &HtmlConfig::default())
                .unwrap();
            vec![
                format!("length   = {} bytes", html.len()),
                format!("minified = {}", !html.contains('\n')),
            ]
        },
    );

    support::summary(5);
}