Fixed merge conflict and failing test

Author: mysticmind

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "nuget"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/workflows/on-push-do-docs.yml

@@ -0,0 +1,22 @@
+name: on-push-do-docs
+on:
+  push:
+jobs:
+  docs:
+    runs-on: ubuntu-20.04
+    steps:
+    - uses: actions/checkout@v2
+    - name: Run MarkdownSnippets
+      run: |
+        dotnet tool install --global MarkdownSnippets.Tool
+        mdsnippets ${GITHUB_WORKSPACE}
+      shell: bash
+    - name: Push changes
+      run: |
+        git config --local user.email "[email protected]"
+        git config --local user.name "GitHub Action"
+        git commit -m "Docs changes [skip ci]" -a  || echo "nothing to commit"
+        remote="https://${GITHUB_ACTOR}:${{secrets.GITHUB_TOKEN}}@github.com/${GITHUB_REPOSITORY}.git"
+        branch="${GITHUB_REF:11}"
+        git push "${remote}" ${branch} || echo "nothing to push"
+      shell: bash

README.md

@@ -1,18 +1,9 @@
-<!--
-GENERATED FILE - DO NOT EDIT
-This file was generated by [MarkdownSnippets](https://github.com/SimonCropp/MarkdownSnippets).
-Source File: /README.source.md
-To change this file edit the source file and then run MarkdownSnippets.
--->
-
 # Meet ReverseMarkdown
 
 [![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/)
 
 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.
 
-Note that the library implementation is based on the Ruby based Html to Markdown converter [ xijo/reverse_markdown](https://github.com/xijo/reverse_markdown).
-
 ## Usage
 
 Install the package from NuGet using `Install-Package ReverseMarkdown` or clone the repository and built it yourself.
@@ -81,7 +72,7 @@ var converter = new ReverseMarkdown.Converter(config);
   * `UnknownTagsOption.Raise` - Raise an error to let you know
 * `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.
 
-  If `string.Empty` provided and when `href` or `src` schema coudn't be determined - whitelists
+  If `string.Empty` provided and when `href` or `src` schema couldn't be determined - whitelists
 
   Schema is determined by `Uri` class, with exception when url begins with `/` (file schema) and `//` (http schema)
 * `TableWithoutHeaderRowHandling` - handle table without header rows
@@ -96,6 +87,9 @@ var converter = new ReverseMarkdown.Converter(config);
 * Can deal with nested lists
 * 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.
 
+## Acknowledgement
+The library implementation is based on the Ruby based Html to Markdown converter [xijo/reverse_markdown](https://github.com/xijo/reverse_markdown).
+
 ## Copyright
 
 Copyright © 2020 Babu Annamalai

README.source.md

@@ -10,15 +10,49 @@ Note that the library implementation is based on the Ruby based Html to Markdown
 
 Install the package from NuGet using `Install-Package ReverseMarkdown` or clone the repository and built it yourself.
 
-snippet: Usage
+<!-- snippet: Usage -->
+<a id='snippet-usage'></a>
+```cs
+var converter = new ReverseMarkdown.Converter();
+
+string html = "This a sample <strong>paragraph</strong> from <a href=\"http://test.com\">my site</a>";
+
+string result = converter.Convert(html);
+```
+<sup><a href='/src/ReverseMarkdown.Test/Snippets.cs#L12-L20' title='Snippet source file'>snippet source</a> | <a href='#snippet-usage' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
 
 Will result in:
 
-snippet: Snippets.Usage.verified.txt
+<!-- snippet: Snippets.Usage.verified.txt -->
+<a id='snippet-Snippets.Usage.verified.txt'></a>
+```txt
+This a sample **paragraph** from [my site](http://test.com)
+```
+<sup><a href='/src/ReverseMarkdown.Test/Snippets.Usage.verified.txt#L1-L1' title='Snippet source file'>snippet source</a> | <a href='#snippet-Snippets.Usage.verified.txt' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
 
 The conversion can be customized:
 
-snippet: UsageWithConfig
+<!-- snippet: UsageWithConfig -->
+<a id='snippet-usagewithconfig'></a>
+```cs
+var config = new ReverseMarkdown.Config
+{
+    // Include the unknown tag completely in the result (default as well)
+    UnknownTags = Config.UnknownTagsOption.PassThrough,
+    // generate GitHub flavoured markdown, supported for BR, PRE and table tags
+    GithubFlavored = true,
+    // will ignore all comments
+    RemoveComments = true,
+    // remove markdown output for links where appropriate
+    SmartHrefHandling = true
+};
+
+var converter = new ReverseMarkdown.Converter(config);
+```
+<sup><a href='/src/ReverseMarkdown.Test/Snippets.cs#L28-L44' title='Snippet source file'>snippet source</a> | <a href='#snippet-usagewithconfig' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
 
 ## Configuration options
 
@@ -38,10 +72,11 @@ snippet: UsageWithConfig
   * `UnknownTagsOption.Drop` - Drop the unknown tag and its content
   * `UnknownTagsOption.Bypass` - Ignore the unknown tag but try to convert its content
   * `UnknownTagsOption.Raise` - Raise an error to let you know
+* `PassThroughTags` - Pass a list of tags to pass through as-is without any processing.
 * `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.
 
-  If `string.Empty` provided and when `href` or `src` schema coudn't be determined - whitelists
-  
+  If `string.Empty` provided and when `href` or `src` schema couldn't be determined - whitelists
+
   Schema is determined by `Uri` class, with exception when url begins with `/` (file schema) and `//` (http schema)
 * `TableWithoutHeaderRowHandling` - handle table without header rows
   * `TableWithoutHeaderRowHandlingOption.Default` - First row will be used as header row (default)

src/ReverseMarkdown.Test/ConverterTests.cs

@@ -808,9 +808,9 @@ public void WhenTable_ThenConvertToGFMTable()
             const string html =
                 @"<table><tr><th>col1</th><th>col2</th><th>col3</th></tr><tr><td>data1</td><td>data2</td><td>data3</td></tr></table>";
             var expected = $"{Environment.NewLine}{Environment.NewLine}";
-            expected += $"    | col1 | col2 | col3 |{Environment.NewLine}";
-            expected += $"    | --- | --- | --- |{Environment.NewLine}";
-            expected += $"    | data1 | data2 | data3 |{Environment.NewLine}";
+            expected += $"| col1 | col2 | col3 |{Environment.NewLine}";
+            expected += $"| --- | --- | --- |{Environment.NewLine}";
+            expected += $"| data1 | data2 | data3 |{Environment.NewLine}";
             expected += Environment.NewLine;
 
             var config = new Config

src/ReverseMarkdown/ReverseMarkdown.csproj

@@ -22,4 +22,4 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All" />
   </ItemGroup>
-</Project>
+</Project>

src/mdsnippets.json

@@ -0,0 +1,3 @@
+{
+  "Convention": "InPlaceOverwrite"
+}