Struct MarkdownRenderer

pub struct MarkdownRenderer { /* private fields */ }

A struct to handle rendering JSON into Markdown format.

The MarkdownRenderer provides customizable options for indentation and depth handling.

Implementations

impl MarkdownRenderer

pub fn new(indent_spaces: usize, depth_increment: usize) -> Self

Creates a new MarkdownRenderer.

Arguments

• indent_spaces - Number of spaces to use for indentation. Always try to use 1 at first.
• depth_increment - Increment to apply for nested structures. Always try to use 2 at first

You can experiment with different values, it still not perfect.

Examples

let renderer = MarkdownRenderer::new(1, 2);

Examples found in repository

examples/basic.rs (line 7)

fn main() {
    let json: Value = serde_json::from_str(r#"{"title": "My Project"}"#).unwrap();

    let renderer = MarkdownRenderer::new(1, 2);
    let markdown = renderer.render(&json);

    println!("{}", markdown);
}

pub fn render(&self, json: &Value) -> String

Renders a JSON value into a Markdown string.

Arguments

• json - The JSON value to render.

Returns

A String containing the rendered Markdown.

Examples

let renderer = MarkdownRenderer::new(1, 2);
let json = serde_json::json!({"title": "My Document"});
let markdown = renderer.render(&json);
assert_eq!(markdown, "");

Examples found in repository

examples/basic.rs (line 8)

fn main() {
    let json: Value = serde_json::from_str(r#"{"title": "My Project"}"#).unwrap();

    let renderer = MarkdownRenderer::new(1, 2);
    let markdown = renderer.render(&json);

    println!("{}", markdown);
}