markly 0.3.0

Native Rust library for parsing Markdown and (outputting HTML)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

//! A crate for parsing Markdown in Rust
#![crate_name = "markly"]
#![deny(missing_docs)]
// #![deny(warnings)]
#![cfg_attr(feature = "clippy", feature(plugin))]
#![cfg_attr(feature = "clippy", plugin(clippy))]

extern crate regex;

#[macro_use]
extern crate pipeline;

#[macro_use]
extern crate lazy_static;

use std::fs::File;
use std::io::{self, Read};
use std::path::Path;

mod html;
mod markdown_generator;
mod parser;

pub use parser::{Block, ListItem, Span};

/// Converts a Markdown string to HTML
pub fn to_html(text: &str) -> String {
    let result = parser::parse(text);
    html::to_html(&result)
}

/// Converts a Markdown string to a tokenset of Markdown items
pub fn tokenize(text: &str) -> Vec<Block> {
    parser::parse(text)
}

/// Convert tokenset of Markdown items back to String
pub fn generate_markdown(x: Vec<Block>) -> String {
    markdown_generator::generate(x)
}

/// Opens a file and converts its contents to HTML
pub fn file_to_html(path: &Path) -> io::Result<String> {
    let mut file = File::open(path)?;

    let mut text = String::new();
    file.read_to_string(&mut text)?;

    let result = parser::parse(&text);
    Ok(html::to_html(&result))
}