markly

Crates.iomarkly
lib.rsmarkly
version0.3.0
sourcesrc
created_at2020-07-26 06:28:08.451596
updated_at2020-07-26 06:28:08.451596
descriptionNative Rust library for parsing Markdown and (outputting HTML)
homepage
repositoryhttps://github.com/genuinebyte/markly.rs
max_upload_size
id269660
size139,445
(gennyble)

documentation

README

markly.rs Crate

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

Forked from the markdown crate.

Usage

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

[dependencies]
markly = "0.3"

Now you can use the crate in your code with

use markly;

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 = markly::to_html("__I am markdown__");

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

TODO

  • Reference Style Images
  • Inline HTML
  • Backslash Escapes
  • Automatic 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.

Commit count: 0

cargo fmt