marq 2.0.0

Markdown rendering with pluggable code block handlers
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

//! Heading extraction and slug generation.

/// A heading extracted from the markdown document.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Heading {
    /// The heading text (without the `#` prefix)
    pub title: String,
    /// The slug ID for linking (e.g., "my-heading")
    pub id: String,
    /// The heading level (1-6)
    pub level: u8,
    /// Line number where this heading appears (1-indexed)
    pub line: usize,
}

/// Generate a URL-safe slug from text.
///
/// Converts to lowercase, replaces non-alphanumeric characters (except dots)
/// with hyphens, and removes leading/trailing hyphens.
///
/// # Example
///
/// ```
/// use marq::slugify;
///
/// assert_eq!(slugify("Hello World"), "hello-world");
/// assert_eq!(slugify("My API (v2)"), "my-api-v2");
/// assert_eq!(slugify("  Spaced  Out  "), "spaced-out");
/// assert_eq!(slugify("i.have.dots"), "i.have.dots");
/// ```
pub fn slugify(text: &str) -> String {
    let mut result = String::with_capacity(text.len());
    let mut last_was_hyphen = true; // Start true to skip leading hyphens

    for c in text.chars() {
        if c.is_alphanumeric() || c == '.' {
            result.push(c.to_ascii_lowercase());
            last_was_hyphen = false;
        } else if !last_was_hyphen {
            result.push('-');
            last_was_hyphen = true;
        }
    }

    // Remove trailing hyphen
    if result.ends_with('-') {
        result.pop();
    }

    result
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_slugify_simple() {
        assert_eq!(slugify("Hello World"), "hello-world");
    }

    #[test]
    fn test_slugify_special_chars() {
        assert_eq!(slugify("My API (v2)"), "my-api-v2");
    }

    #[test]
    fn test_slugify_numbers() {
        assert_eq!(slugify("Chapter 1: Introduction"), "chapter-1-introduction");
    }

    #[test]
    fn test_slugify_consecutive_spaces() {
        assert_eq!(slugify("a   b"), "a-b");
    }

    #[test]
    fn test_slugify_leading_trailing() {
        assert_eq!(slugify("  Hello  "), "hello");
    }

    #[test]
    fn test_slugify_unicode() {
        // Unicode alphanumeric chars should be preserved (lowercased)
        assert_eq!(slugify("Héllo Wörld"), "héllo-wörld");
    }

    #[test]
    fn test_slugify_empty() {
        assert_eq!(slugify(""), "");
        assert_eq!(slugify("   "), "");
    }

    #[test]
    fn test_slugify_dots() {
        assert_eq!(slugify("i.have.dots"), "i.have.dots");
        assert_eq!(slugify("config.path.default"), "config.path.default");
    }
}