cmark-writer 0.7.0

A CommonMark writer implementation in Rust for serializing AST nodes to CommonMark format
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

//! GFM task list support
//!
//! This module provides utilities for working with GitHub Flavored Markdown
//! task lists (checkboxes).

use crate::ast::Node;
pub use crate::ast::TaskListStatus;

/// Creates a checked (completed) task list item
///
/// # Arguments
/// * `content` - The content of the task list item
///
/// # Returns
/// A task list item node with a checked status
pub fn checked_task(content: Vec<Node>) -> Node {
    Node::task_list_item(TaskListStatus::Checked, content)
}

/// Creates an unchecked (pending) task list item
///
/// # Arguments
/// * `content` - The content of the task list item
///
/// # Returns
/// A task list item node with an unchecked status
pub fn unchecked_task(content: Vec<Node>) -> Node {
    Node::task_list_item(TaskListStatus::Unchecked, content)
}

/// Creates a task list with multiple items
///
/// # Arguments
/// * `items` - A vector of tuples containing the status and content for each task
///
/// # Returns
/// An unordered list node containing task items
pub fn task_list(items: Vec<(TaskListStatus, Vec<Node>)>) -> Node {
    let list_items = items
        .into_iter()
        .map(|(status, content)| match status {
            TaskListStatus::Checked => checked_task(content),
            TaskListStatus::Unchecked => unchecked_task(content),
        })
        .collect::<Vec<_>>();

    Node::Document(list_items)
}