Skip to content

Commit d1969ed

Browse files
committed
Update readme to include ListBullerChar config [skip ci]
1 parent 4b8419b commit d1969ed

File tree

2 files changed

+15
-6
lines changed

2 files changed

+15
-6
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
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/)
@@ -57,15 +64,16 @@ var converter = new ReverseMarkdown.Converter(config);
5764
## Configuration options
5865

5966
* `GithubFlavored` - Github style markdown for br, pre and table. Default is false
67+
* `ListBulletChar` - Allows to change the bullet character. Default value is `-`. Some systems expect the bullet character to be `*` rather than `-`, this config allows to change it. Available in v3.12.0.
6068
* `RemoveComments` - Remove comment tags with text. Default is false
6169
* `SmartHrefHandling` - how to handle `<a>` tag href attribute
6270
* `false` - Outputs `[{name}]({href}{title})` even if name and href is identical. This is the default option.
6371
* `true` - If name and href equals, outputs just the `name`. Note that if Uri is not well formed as per [`Uri.IsWellFormedUriString`](https://docs.microsoft.com/en-us/dotnet/api/system.uri.iswellformeduristring) (i.e string is not correctly escaped like `http://example.com/path/file name.docx`) then markdown syntax will be used anyway.
64-
72+
6573
If `href` contains `http/https` protocol, and `name` doesn't but otherwise are the same, output `href` only
66-
74+
6775
If `tel:` or `mailto:` scheme, but afterwards identical with name, output `name` only.
68-
* `UnknownTags` - handle unknown tags.
76+
* `UnknownTags` - handle unknown tags.
6977
* `UnknownTagsOption.PassThrough` - Include the unknown tag completely into the result. That is, the tag along with the text will be left in output. This is the default
7078
* `UnknownTagsOption.Drop` - Drop the unknown tag and its content
7179
* `UnknownTagsOption.Bypass` - Ignore the unknown tag but try to convert its content

README.source.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,16 @@ snippet: UsageWithConfig
2323
## Configuration options
2424

2525
* `GithubFlavored` - Github style markdown for br, pre and table. Default is false
26+
* `ListBulletChar` - Allows to change the bullet character. Default value is `-`. Some systems expect the bullet character to be `*` rather than `-`, this config allows to change it. Available in v3.12.0.
2627
* `RemoveComments` - Remove comment tags with text. Default is false
2728
* `SmartHrefHandling` - how to handle `<a>` tag href attribute
2829
* `false` - Outputs `[{name}]({href}{title})` even if name and href is identical. This is the default option.
2930
* `true` - If name and href equals, outputs just the `name`. Note that if Uri is not well formed as per [`Uri.IsWellFormedUriString`](https://docs.microsoft.com/en-us/dotnet/api/system.uri.iswellformeduristring) (i.e string is not correctly escaped like `http://example.com/path/file name.docx`) then markdown syntax will be used anyway.
30-
31+
3132
If `href` contains `http/https` protocol, and `name` doesn't but otherwise are the same, output `href` only
32-
33+
3334
If `tel:` or `mailto:` scheme, but afterwards identical with name, output `name` only.
34-
* `UnknownTags` - handle unknown tags.
35+
* `UnknownTags` - handle unknown tags.
3536
* `UnknownTagsOption.PassThrough` - Include the unknown tag completely into the result. That is, the tag along with the text will be left in output. This is the default
3637
* `UnknownTagsOption.Drop` - Drop the unknown tag and its content
3738
* `UnknownTagsOption.Bypass` - Ignore the unknown tag but try to convert its content

0 commit comments

Comments
 (0)