markdown.rs

A simple native Rust library for parsing Markdown and (outputting HTML).

Usage

To include markdown in your project add the following to your Cargo.toml:

[dependencies]
markdown = "0.3"

Now you can use the crate in your code with

extern crate markdown;

There is no full documentation right now, the only function exported by the library is to_html, which takes a markdown &str and converts it to an owned String containing html.

let html : String = markdown::to_html("__I am markdown__");

assert_eq!(&html, "<strong>I am markdown</strong>")

TODO

• [ ] Inline HTML
• [ ] Automatic Links
• [ ] Obscure Emails

License

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.