use-markdown 0.1.0

Composable Markdown text primitives for RustUse.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

use crate::heading::{MarkdownHeading, extract_headings};

/// A simple heading outline for a Markdown document.
#[derive(Clone, Debug, Default, Eq, PartialEq)]
pub struct MarkdownOutline {
    /// The headings found in document order.
    pub headings: Vec<MarkdownHeading>,
}

/// Extracts a lightweight document outline from headings.
pub fn extract_outline(markdown: &str) -> MarkdownOutline {
    MarkdownOutline {
        headings: extract_headings(markdown),
    }
}