Rust Markdown parsing library
Rust
Switch branches/tags
Nothing to show
Clone or download
johannhof Merge pull request #22 from PENGUINLIONG/utf8-fix
Fixed UTF8-error-prone codes
Latest commit 788aa51 Oct 27, 2017

README.md

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.2"

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
  • Backslash Escapes
  • Automatic Links
  • Reference-Style Links
  • List wrapping
  • HTML Entities
  • Obscure Emails

License

Licensed under either of

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.