markdown 0.1.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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

markdown.rs [![](https://travis-ci.org/johannhof/markdown.rs.svg?branch=master)](https://travis-ci.org/johannhof/markdown.rs)
===========

A native Rust library for parsing Markdown and (outputting HTML) written to be used by my WIP static site generator [Lava](https://github.com/johannhof/lava).

Usage
----------

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

```toml
[dependencies]
markdown = "0.1"

```

Now you can use the crate in your code with
```rust
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.

```rust
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
  - [x] Paragraphs
    - [x] Parsing
    - [x] HTML
    - [x] Tests
  - [x] Line Breaks
    - [x] Parsing
    - [x] HTML
    - [x] Tests
  - [x] Headers
    - [x] Parsing
    - [x] HTML
    - [x] Tests
  - [x] Blockquotes
    - [x] Parsing
    - [x] HTML
    - [x] Tests
  - [ ] Lists
    - [x] Parsing
    - [x] HTML
    - [ ] Tests
  - [x] Code Blocks
    - [x] Parsing
    - [x] HTML
    - [x] Tests
  - [x] Horizontal Rules
    - [x] Parsing
    - [x] HTML
    - [x] Tests
- [x] Span Elements
  - [x] Links
    - [x] Parsing
    - [x] HTML
    - [x] Tests
  - [x] Emphasis
    - [x] Parsing
    - [x] HTML
    - [x] Tests
  - [x] Strong
    - [x] Parsing
    - [x] HTML
    - [x] Tests
  - [x] Code
    - [x] Parsing
    - [x] HTML
    - [x] Tests
  - [x] Images
    - [x] Parsing
    - [x] HTML
    - [x] Tests