Merge branch 'main' of https://github.com/mcpride/ms-markdig-extensions

.github/workflows/ci.yml

@@ -12,6 +12,8 @@ on:
  - "McPride.Markdig*-v[0-9]+.[0-9]+.[0-9]+-preview[0-9]+.[0-9]+"
  - "McPride.Markdig*-v[0-9]+.[0-9]+.[0-9]+-prerelease[0-9]+.[0-9]+"
  - "McPride.Markdig*-v[0-9]+.[0-9]+.[0-9]+-pre[0-9]+.[0-9]+"
+ paths-ignore:
+ - '**/README.md'
  pull_request:
  branches: [ "main" ]
 

src/McPride.Markdig.AsciiDoc/README.md

@@ -13,9 +13,38 @@ The renderer is marked with a 0 as major version which means, this is in an earl
 
 With update to version 1.0.0 and higher the versioning then will follow the semver pattern.
 
+### Features
+
+* Link handling inclusive images etc.
+* Code block handling (incl. special plantuml diagram handling)
+* Paragraph handling
+* Headings
+* Ordered and unordered lists
+* Quote blocks
+* Simple pipe or grid tables 
+* Thematic breaks
+* Inline literal, bold, italic, underline, strikethrough, superscript, subscript etc. handling
+* breaks
+* ... etc.
+
+### TODOs (mostly not part of CommonMark markdown)
+
+* Footnotes
+* complex table handling (grid tables)
+* custom (html) attributes handling
+* Admonitions
+* Abbreviations
+* Citations
+* Additional diagrams
+* Emojis
+* Mathematics
+* additional media links
+* Task lists
+* ... support for other markdown extensions
+
 ## Installation
 
-You can add `McPride.Markdig.AsciiDoc` as nuget package to your project.
+You can add `McPride.Markdig.AsciiDoc` as [nuget package](https://www.nuget.org/packages/McPride.Markdig.AsciiDoc) to your project.
 
 * dotnet cli: `dotnet add package McPride.Markdig.AsciiDoc`
 * PS Package Manager: `Install-Package McPride.Markdig.AsciiDoc`