You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2022/12/22 07:12:48 UTC
[maven-doxia] branch DOXIA-617 created (now 94df91bb)
This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a change to branch DOXIA-617
in repository https://gitbox.apache.org/repos/asf/maven-doxia.git
at 94df91bb [DOXIA-617] support yaml metadata
This branch includes the following new commits:
new 94df91bb [DOXIA-617] support yaml metadata
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[maven-doxia] 01/01: [DOXIA-617] support yaml metadata
Posted by hb...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to branch DOXIA-617
in repository https://gitbox.apache.org/repos/asf/maven-doxia.git
commit 94df91bb7b910fe8f7130c01fd3398d59720262c
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Thu Dec 22 08:12:41 2022 +0100
[DOXIA-617] support yaml metadata
---
.../maven/doxia/module/markdown/MarkdownParser.java | 7 +++++++
.../doxia/module/markdown/MarkdownParserTest.java | 19 ++++++++++++++++++-
.../src/test/resources/metadata-yaml.md | 14 ++++++++++++++
3 files changed, 39 insertions(+), 1 deletion(-)
diff --git a/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownParser.java b/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownParser.java
index 33057eaf..462939c6 100644
--- a/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownParser.java
+++ b/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownParser.java
@@ -198,6 +198,13 @@ public class MarkdownParser
html.append( "<html>" );
html.append( "<head>" );
+ // detect yaml style metadata
+ if ( text.startsWith( "---" ) )
+ {
+ // remove the enclosing --- to get back to classical metadata
+ text = text.replaceFirst( "---", "" ).replaceFirst( "---", "" );
+ }
+
// First, we interpret the "metadata" section of the document and add the corresponding HTML headers
Matcher metadataMatcher = METADATA_SECTION_PATTERN.matcher( text );
boolean haveTitle = false;
diff --git a/doxia-modules/doxia-module-markdown/src/test/java/org/apache/maven/doxia/module/markdown/MarkdownParserTest.java b/doxia-modules/doxia-module-markdown/src/test/java/org/apache/maven/doxia/module/markdown/MarkdownParserTest.java
index 11e4da53..35b3799f 100644
--- a/doxia-modules/doxia-module-markdown/src/test/java/org/apache/maven/doxia/module/markdown/MarkdownParserTest.java
+++ b/doxia-modules/doxia-module-markdown/src/test/java/org/apache/maven/doxia/module/markdown/MarkdownParserTest.java
@@ -300,7 +300,24 @@ public class MarkdownParserTest
public void testMetadataSinkEvent()
throws Exception
{
- List<SinkEventElement> eventList = parseFileToEventTestingSink( "metadata" ).getEventList();
+ testMetadataSinkEvent( "metadata" );
+ }
+
+ /**
+ * Assert the metadata is passed through when parsing "metadata-yaml.md".
+ *
+ * @throws Exception if the event list is not correct when parsing the document
+ */
+ public void testMetadataYamlSinkEvent()
+ throws Exception
+ {
+ testMetadataSinkEvent( "metadata-yaml" );
+ }
+
+ private void testMetadataSinkEvent( String doc )
+ throws Exception
+ {
+ List<SinkEventElement> eventList = parseFileToEventTestingSink( doc ).getEventList();
Iterator<SinkEventElement> it = eventList.iterator();
assertEquals( it, "head", "title", "text", "text", "text", "title_", "author", "text", "author_", "date", "text", "date_",
diff --git a/doxia-modules/doxia-module-markdown/src/test/resources/metadata-yaml.md b/doxia-modules/doxia-module-markdown/src/test/resources/metadata-yaml.md
new file mode 100644
index 00000000..406c74ff
--- /dev/null
+++ b/doxia-modules/doxia-module-markdown/src/test/resources/metadata-yaml.md
@@ -0,0 +1,14 @@
+---
+title: A Title & a 'Test'
+author: Somebody 'Nickname' Great <so...@somewhere.org>
+date: 2013 © Copyleft
+keywords: maven,doxia,markdown
+---
+
+# The document with look-alike header
+
+copyright: none
+
+## A subheading
+
+Some more text
\ No newline at end of file