README.md

markdown-fmt

A library that applies a light touch when formatting markdown documents. The project supports CommonMark and GitHub Flavored Markdown

How To Use

If you don't need to configure anything and just want to get started, you can use the the high-level rewrite_markdown function.

use markdown_fmt::rewrite_markdown;

let markdown = r##"  # Getting Started
1. numbered lists
1.  are easy!

> > and so are block quotes.
"##;

let expected = r##"# Getting Started
1. numbered lists
1. are easy!

>> and so are block quotes.
"##;

let output = rewrite_markdown(markdown).unwrap();
assert_eq!(output, expected);

If you need more control over markdown formatting you can use the FormatBuilder and the rewrite_markdown_with_builder function.

use markdown_fmt::{FormatBuilder, rewrite_markdown_with_builder};

let markdown = r##"# The standard Lorem Ipsum passage, used since the 1500s

"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
"##;

let expected = r##"# The standard Lorem Ipsum passage, used since the 1500s

"Lorem ipsum dolor sit amet, consectetur
adipiscing elit, sed do eiusmod tempor incididunt
ut labore et dolore magna aliqua. Ut enim ad minim
veniam, quis nostrud exercitation ullamco laboris
nisi ut aliquip ex ea commodo consequat. Duis aute
irure dolor in reprehenderit in voluptate velit
esse cillum dolore eu fugiat nulla pariatur.
Excepteur sint occaecat cupidatat non proident,
sunt in culpa qui officia deserunt mollit anim id
est laborum."
"##;

let mut builder = FormatBuilder::default();
builder.max_width(Some(50)).reflow_text(true);

let output = rewrite_markdown_with_builder(markdown, builder).unwrap();
assert_eq!(output, expected);

You can also configure how code blocks are formatted.

use markdown_fmt::{FormatBuilder, rewrite_markdown_with_builder};

let markdown = "```text\nhello world!\n```";

let expected = "```text\nHELLO WORLD!\n```";

let mut builder = FormatBuilder::default();
builder.code_block_formatter(|_ctx, info_str, code_block| {
    match info_str {
        "text" => code_block.to_uppercase(),
        _ => code_block
    }
});

let output = rewrite_markdown_with_builder(markdown, builder).unwrap();
assert_eq!(output, expected);