File: README.md

package info (click to toggle)
rust-html2md 0.2.15-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 484 kB
  • sloc: makefile: 2
file content (54 lines) | stat: -rw-r--r-- 1,645 bytes parent folder | download
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
HTML2MD
=======

Library to convert simple html documents into markdown flavor.
Implements markdown as written on its [inception page](https://daringfireball.net/projects/markdown).

Features
--------

Currently supported:

+ Lists (and inner lists)
+ Headers
+ Quotes (and inner quotes)
+ Paragraphs
+ Horizontal rulers
+ Images and links
+ Tables
+ Formatting (bold, italic, strikethrough, underline)
+ Code

Limitations
-----------

- no markdown flavors support (-/+ unordered list styles, ##/== headers etc.)
- doesn't yet detect code style

Used libraries
--------------
[html5ever](https://github.com/servo/html5ever) - Servo engine HTML parsing library, used to convert html input to DOM

[regex](https://github.com/rust-lang/regex) - PCRE support in Rust, used to correct whitespaces

Contributions
-------------
You may create merge request or bug/enhancement issue right here on GitLab, or send formatted patch via e-mail. 
For details see CONTRIBUTING.md file in this repo. 

License
-------------

    Copyright (C) 2018-2019  Oleg `Kanedias` Chernovskiy

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

See [COPYING.md](./COPYING.md) for special terms on dual-licensing.