mdx-gen 0.0.4

A robust Rust library for processing Markdown and converting it to HTML with support for custom blocks, enhanced table formatting, and flexible configuration options.
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

// SPDX-License-Identifier: MIT OR Apache-2.0
// Copyright (c) 2026 MDX Gen. All rights reserved.

//! Safe rendering of user-submitted content — SanitizerConfig demo.
//!
//! Run: `cargo run --example cms`

#![allow(clippy::unwrap_used, clippy::expect_used)]

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

use mdx_gen::{process_markdown, MarkdownOptions, SanitizerConfig};

fn main() {
    support::header("mdx-gen -- cms");

    // ── Strict defaults ──────────────────────────────────────────────
    support::task_with_output(
        "Strict defaults strip raw <main> + <script>",
        || {
            let md =
                "<main>wrapper</main>\n\n<script>alert(1)</script>\n";
            let options = base_options();
            let html = process_markdown(md, &options).unwrap();
            vec![
                format!("<main> kept   : {}", html.contains("<main>")),
                format!(
                    "<script> kept : {}",
                    html.contains("<script>")
                ),
            ]
        },
    );

    // ── Add an extra tag ─────────────────────────────────────────────
    support::task_with_output(
        "Allow <main id=\"…\"> via extra tag + attr",
        || {
            let md = "<main id=\"page\">wrapper</main>\n";
            let options = base_options().with_sanitizer_config(
                SanitizerConfig::new()
                    .with_tag("main")
                    .with_tag_attribute("main", "id"),
            );
            let html = process_markdown(md, &options).unwrap();
            vec![format!(
                "<main id> kept: {}",
                html.contains("<main id=\"page\">")
            )]
        },
    );

    // ── Restrict span classes ────────────────────────────────────────
    support::task_with_output(
        "Whitelist span classes (drop everything else)",
        || {
            let md = "<span class=\"badge\">ok</span> <span class=\"danger\">nope</span>\n";
            let options = base_options().with_sanitizer_config(
                SanitizerConfig::new()
                    .with_allowed_class("span", "badge"),
            );
            let html = process_markdown(md, &options).unwrap();
            vec![
                format!(
                    "badge kept    : {}",
                    html.contains("class=\"badge\"")
                ),
                format!(
                    "danger kept   : {}",
                    html.contains("class=\"danger\"")
                ),
            ]
        },
    );

    // ── Opt back into style (trusted content only) ───────────────────
    support::task_with_output(
        "Opt style=\"…\" back in (trusted content only)",
        || {
            let md = "<p style=\"color:red\">alert</p>\n";
            let options = base_options().with_sanitizer_config(
                SanitizerConfig::new().with_generic_attribute("style"),
            );
            let html = process_markdown(md, &options).unwrap();
            vec![format!(
                "style kept    : {}",
                html.contains("style=\"color:red\"")
            )]
        },
    );

    support::summary(4);
}

fn base_options<'a>() -> MarkdownOptions<'a> {
    MarkdownOptions::new()
        .with_custom_blocks(false)
        .with_enhanced_tables(false)
        .with_unsafe_html(false)
}