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
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

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

//! Custom-block alert overrides — re-skin the built-in callouts.
//!
//! Run: `cargo run --example alerts`

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

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

use mdx_gen::{
    process_markdown, CustomBlockConfig, CustomBlockType,
    MarkdownOptions,
};

const SOURCE: &str = r#"<div class="note">A note for the reader.</div>
<div class="warning">Mind the gap.</div>
<div class="tip">Press ⌘K to search.</div>
<div class="info">Build status is green.</div>
<div class="important">Read the migration guide first.</div>
<div class="caution">Backups are advised.</div>
"#;

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

    // ── Default Bootstrap-shaped output ─────────────────────────────
    let default_html =
        support::task("Render with default config", || {
            let options = MarkdownOptions::new()
                .with_custom_blocks(true)
                .with_enhanced_tables(false);
            process_markdown(SOURCE, &options).unwrap()
        });
    support::task_with_output("Inspect default class names", || {
        [
            CustomBlockType::Note,
            CustomBlockType::Warning,
            CustomBlockType::Tip,
            CustomBlockType::Info,
            CustomBlockType::Important,
            CustomBlockType::Caution,
        ]
        .iter()
        .map(|b| {
            format!(
                "{:<10} {:<18} title={}",
                format!("{b:?}"),
                b.get_alert_class(),
                b.get_title()
            )
        })
        .collect()
    });

    // ── Tailwind-style override (callout-* + custom titles) ─────────
    let tailwind_html =
        support::task("Render with Tailwind overrides", || {
            let config = CustomBlockConfig::new()
                .with_class(CustomBlockType::Note, "callout-info")
                .with_class(CustomBlockType::Warning, "callout-warn")
                .with_class(CustomBlockType::Tip, "callout-tip")
                .with_class(CustomBlockType::Info, "callout-info")
                .with_class(
                    CustomBlockType::Important,
                    "callout-danger",
                )
                .with_class(CustomBlockType::Caution, "callout-danger")
                .with_title(CustomBlockType::Note, "Did you know?")
                .with_title(CustomBlockType::Warning, "Heads up")
                .with_title(CustomBlockType::Tip, "Pro tip")
                .with_title(CustomBlockType::Info, "Status")
                .with_title(CustomBlockType::Important, "Required")
                .with_title(CustomBlockType::Caution, "Be careful");

            let options = MarkdownOptions::new()
                .with_custom_blocks(true)
                .with_enhanced_tables(false)
                .with_custom_block_config(config);
            process_markdown(SOURCE, &options).unwrap()
        });

    support::task_with_output("Verify default vs override", || {
        vec![
            format!(
                "default contains 'alert-info'  : {}",
                default_html.contains("alert-info")
            ),
            format!(
                "default contains 'callout-info': {}",
                default_html.contains("callout-info")
            ),
            format!(
                "tailwind contains 'callout-warn': {}",
                tailwind_html.contains("callout-warn")
            ),
            format!(
                "tailwind contains 'Did you know?': {}",
                tailwind_html.contains("Did you know?")
            ),
            format!(
                "tailwind contains 'Heads up'    : {}",
                tailwind_html.contains("Heads up")
            ),
        ]
    });

    // ── Per-block-type lookup helpers ────────────────────────────────
    support::task_with_output(
        "Lookup helpers respect the config",
        || {
            let config = CustomBlockConfig::new()
                .with_class(CustomBlockType::Note, "my-special-note");
            vec![
                format!(
                    "Note default class               : {}",
                    CustomBlockType::Note.get_alert_class()
                ),
                format!(
                    "Note class via alert_class_with  : {}",
                    CustomBlockType::Note.alert_class_with(&config)
                ),
            ]
        },
    );

    support::summary(5);
}