(maven-doxia) branch master updated: Improve documentation of supported extensions

[kw...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

kwin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-doxia.git


The following commit(s) were added to refs/heads/master by this push:
     new bfe3c682 Improve documentation of supported extensions
bfe3c682 is described below

commit bfe3c6822eddcf761eb80aab0abebd20c96f4fa3
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Fri Aug 1 21:00:18 2025 +0200

    Improve documentation of supported extensions
    
    This closes #991
---
 .../doxia-module-markdown/src/site/apt/index.apt   | 43 ++++++++++++++++++++++
 1 file changed, 43 insertions(+)

diff --git a/doxia-modules/doxia-module-markdown/src/site/apt/index.apt b/doxia-modules/doxia-module-markdown/src/site/apt/index.apt
index b83bf1ca..bbfbb15c 100644
--- a/doxia-modules/doxia-module-markdown/src/site/apt/index.apt
+++ b/doxia-modules/doxia-module-markdown/src/site/apt/index.apt
@@ -40,6 +40,49 @@ doxia-module-markdown
   * {{{http://fletcher.github.io/MultiMarkdown-5/metadata.html}MultiMarkdown Metadata}}
 
   * {{{https://github.com/vsch/flexmark-java/wiki/Extensions#yaml-front-matter}YAML front matter}}
+  
+  Metadata must be placed at the beginning of the document, before any other content.
+  
+  []
+
+  Currently only the following metadata elements are supported:
+  
+  * <<<title>>> - the title of the document, used as the sink's title
+  
+  * <<<author>>> - the author of the document, used as the sink's author
+  
+  * <<<date>>> - the date of the document, used as the sink's date
+  
+  * everything else is just written as meta tags in the output document
+  
+
+* Extensions
+
+  As the original Markdown specification is simple many extensions have been created to add features to the original Markdown format.
+  The following extensions are supported by this module:
+  
+** GFM (GitHub Flavored Markdown) extensions:
+  
+  GitHub specified {{{https://github.github.com/gfm}extensions}} to the original Markdown format, which are now widely used. 
+  Some of these extensions are also supported by this module.
+  
+  * {{{https://github.github.com/gfm/#tables-extension-}tables}}
+  
+  * {{{https://github.github.com/gfm/#strikethrough-extension-}strikethrough text}}
+
+** Others
+
+  * {{{https://github.com/vsch/flexmark-java/wiki/Extensions#wikilinks}wiki links}}
+  
+  * {{{https://github.com/vsch/flexmark-java/wiki/Footnotes-Extension}footnotes}}
+  
+  * {{{https://michelf.ca/projects/php-markdown/extra/#abbr}abbreviations}}
+  
+  * {{{https://michelf.ca/projects/php-markdown/extra/#def-list}definition lists}}
+  
+* Parser
+
+  The parser will first convert Markdown into HTML and then parse the HTML into Doxia Sink API methods calls.
 
 * References