prettify-cmark

CommonMark文档的格式化输出。

文档

安装

将以下内容添加到您的 Cargo.toml

[dependencies]
prettify-cmark = "0.1"

示例

extern crate pulldown_cmark;
extern crate prettify_cmark;

use pulldown_cmark::Parser;
use prettify_cmark::PrettyPrinter;

fn main() {
    let events = Parser::new("Lorem _ipsum_ dolor `sit`.");
    let mut printer = PrettyPrinter::default();
    printer.push_events(events).unwrap();

    assert_eq!(printer.into_inner(), "Lorem *ipsum* dolor `sit`.")
}

lib.rs:

CommonMark文档的格式化输出。

简单API

对于简单用例，可以使用 prettify 函数来解析和格式化输出一个CommonMark文档。

use prettify_cmark::prettify;

let output = prettify("Lorem __ipsum__ dolor `sit` amet!");

assert_eq!(output,  "Lorem **ipsum** dolor `sit` amet!")

高级API

对于更高级的用例，这个crate设计得与 pulldown-cmark crate很好地协同工作。

它提供了一个 PrettyPrinter，它可以包装一个输出类型（如String），并将从pulldown-cmark获得的的事件推送到其中。

use pulldown_cmark::Parser;
use prettify_cmark::PrettyPrinter;

let events = Parser::new("Lorem _ipsum_ dolor `sit`.");
let mut printer = PrettyPrinter::default();
printer.push_events(events).unwrap();

assert_eq!(printer.into_inner(), "Lorem *ipsum* dolor `sit`.")