Skip to content

Commit e3cbdfb

Browse files
committed
Update readme
1 parent dabf925 commit e3cbdfb

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,18 @@
1+
<!--
2+
GENERATED FILE - DO NOT EDIT
3+
This file was generated by [MarkdownSnippets](https://github.com/SimonCropp/MarkdownSnippets).
4+
Source File: /README.source.md
5+
To change this file edit the source file and then run MarkdownSnippets.
6+
-->
7+
18
# Meet ReverseMarkdown
29

310
[![Windows Build status](https://ci.appveyor.com/api/projects/status/xse0bia9olr5shxr?svg=true)](https://ci.appveyor.com/project/BabuAnnamalai/reversemarkdown-net) [![Windows Build status](https://api.travis-ci.org/mysticmind/reversemarkdown-net.svg)](https://travis-ci.org/mysticmind/reversemarkdown-net) [![NuGet Version](https://badgen.net/nuget/v/reversemarkdown)](https://www.nuget.org/packages/ReverseMarkdown/)
411

512
ReverseMarkdown is a Html to Markdown (http://daringfireball.net/projects/markdown/syntax) converter library in C#. Conversion is very reliable since HtmlAgilityPack (HAP) library is used for traversing the Html DOM.
613

14+
Note that the library implementation is based on the Ruby based Html to Markdown converter [ xijo/reverse_markdown](https://github.com/xijo/reverse_markdown).
15+
716
## Usage
817

918
Install the package from NuGet using `Install-Package ReverseMarkdown` or clone the repository and built it yourself.
@@ -70,10 +79,11 @@ var converter = new ReverseMarkdown.Converter(config);
7079
* `UnknownTagsOption.Drop` - Drop the unknown tag and its content
7180
* `UnknownTagsOption.Bypass` - Ignore the unknown tag but try to convert its content
7281
* `UnknownTagsOption.Raise` - Raise an error to let you know
82+
* `PassThroughTags` - Pass a list of tags to pass through as-is without any processing.
7383
* `WhitelistUriSchemes` - Specify which schemes (without trailing colon) are to be allowed for `<a>` and `<img>` tags. Others will be bypassed (output text or nothing). By default allows everything.
7484

7585
If `string.Empty` provided and when `href` or `src` schema couldn't be determined - whitelists
76-
86+
7787
Schema is determined by `Uri` class, with exception when url begins with `/` (file schema) and `//` (http schema)
7888
* `TableWithoutHeaderRowHandling` - handle table without header rows
7989
* `TableWithoutHeaderRowHandlingOption.Default` - First row will be used as header row (default)
@@ -87,9 +97,6 @@ var converter = new ReverseMarkdown.Converter(config);
8797
* Can deal with nested lists
8898
* Github Flavoured Markdown conversion supported for br, pre and table. Use `var config = new ReverseMarkdown.Config(githubFlavoured:true);`. By default table will always be converted to Github flavored markdown immaterial of this flag.
8999

90-
## Acknowledgement
91-
The library implementation is based on the Ruby based Html to Markdown converter [xijo/reverse_markdown](https://github.com/xijo/reverse_markdown).
92-
93100
## Copyright
94101

95102
Copyright © 2020 Babu Annamalai

0 commit comments

Comments
 (0)