markdown.rs

A native Rust library for parsing Markdown and (outputting HTML) written to be used by my WIP static site generator Lava.

Usage

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

[dependencies]
markdown = "0.1"

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__");

Roadmap

Implement all John Gruber Markdown features and have them tested

• Inline HTML
• Automatic Escaping for Special Characters
• Backslash Escapes
• Automatic Links
• Block Elements
  • Paragraphs
    • Parsing
    • HTML
    • Tests
  • Line Breaks
    • Parsing
    • HTML
    • Tests
  • Headers
    • Parsing
    • HTML
    • Tests
  • Blockquotes
    • Parsing
    • HTML
    • Tests
  • Lists
    • Parsing
    • HTML
    • Tests
  • Code Blocks
    • Parsing
    • HTML
    • Tests
  • Horizontal Rules
    • Parsing
    • HTML
    • Tests
• Span Elements
  • Links
    • Parsing
    • HTML
    • Tests
  • Emphasis
    • Parsing
    • HTML
    • Tests
  • Strong
    • Parsing
    • HTML
    • Tests
  • Code
    • Parsing
    • HTML
    • Tests
  • Images
    • Parsing
    • HTML
    • Tests