Author: hboutemy
Date: Sun Feb 25 18:05:38 2018
New Revision: 1825319
URL: http://svn.apache.org/viewvc?rev=1825319&view=rev
Log:
[MARCHETYPES-55] added Markdown examples
Added:
maven/archetypes/trunk/maven-archetype-plugin-site/src/main/resources/archetype-resources/src/site/markdown/
maven/archetypes/trunk/maven-archetype-plugin-site/src/main/resources/archetype-resources/src/site/markdown/markdown-velocity.md.vm
maven/archetypes/trunk/maven-archetype-plugin-site/src/main/resources/archetype-resources/src/site/markdown/markdown.md
maven/archetypes/trunk/maven-archetype-site-simple/src/site/markdown/
maven/archetypes/trunk/maven-archetype-site-simple/src/site/markdown/markdown-velocity.md.vm
maven/archetypes/trunk/maven-archetype-site-simple/src/site/markdown/markdown.md
maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/fr/markdown/
maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/fr/markdown/markdown-velocity.md.vm
maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/fr/markdown/markdown.md
maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/markdown/
maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/markdown/markdown-velocity.md.vm
maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/markdown/markdown.md
Modified:
maven/archetypes/trunk/maven-archetype-plugin-site/src/main/resources/archetype-resources/src/site/site.xml
maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/site.xml
maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/site_fr.xml
maven/archetypes/trunk/maven-archetype-site/src/site/apt/index.apt.vm
Added:
maven/archetypes/trunk/maven-archetype-plugin-site/src/main/resources/archetype-resources/src/site/markdown/markdown-velocity.md.vm
URL:
http://svn.apache.org/viewvc/maven/archetypes/trunk/maven-archetype-plugin-site/src/main/resources/archetype-resources/src/site/markdown/markdown-velocity.md.vm?rev=1825319&view=auto
==============================================================================
---
maven/archetypes/trunk/maven-archetype-plugin-site/src/main/resources/archetype-resources/src/site/markdown/markdown-velocity.md.vm
(added)
+++
maven/archetypes/trunk/maven-archetype-plugin-site/src/main/resources/archetype-resources/src/site/markdown/markdown-velocity.md.vm
Sun Feb 25 18:05:38 2018
@@ -0,0 +1,13 @@
+Markdown Format with Velocity works
+---------------
+
+#[[###]]# But Markdown conflicts with Velocity on `${esc.h}${esc.h}` syntax
+
+Since `${esc.h}${esc.h}` denotes a
+[single line
comment](http://velocity.apache.org/engine/1.7/vtl-reference.html#single-line-comments)
in Velocity,
+Markdown headers using this syntax are suppressed from generated content.
+
+You can use [unparsed content
syntax](http://velocity.apache.org/engine/1.7/vtl-reference.html#unparsed-content)
+`${esc.h}[[#[[##]]#]]${esc.h}` or
+[escape
tool](http://velocity.apache.org/tools/2.0/apidocs/org/apache/velocity/tools/generic/EscapeTool.html)
+like `${esc.d}{esc.h}${esc.d}{esc.h}`.
Added:
maven/archetypes/trunk/maven-archetype-plugin-site/src/main/resources/archetype-resources/src/site/markdown/markdown.md
URL:
http://svn.apache.org/viewvc/maven/archetypes/trunk/maven-archetype-plugin-site/src/main/resources/archetype-resources/src/site/markdown/markdown.md?rev=1825319&view=auto
==============================================================================
---
maven/archetypes/trunk/maven-archetype-plugin-site/src/main/resources/archetype-resources/src/site/markdown/markdown.md
(added)
+++
maven/archetypes/trunk/maven-archetype-plugin-site/src/main/resources/archetype-resources/src/site/markdown/markdown.md
Sun Feb 25 18:05:38 2018
@@ -0,0 +1,11 @@
+Markdown Format works
+---------------
+
+You can write your documentation in Markdown...
+
+<!-- MACRO{toc|fromDepth=1|toDepth=2} -->
+
+### Subsection
+
+If you want to filter content with Velocity (files ending in `.vm`), please
have a look at
+explanations on [Markdown conflict with Velocity on `##`
syntax](./markdown-velocity.html).
\ No newline at end of file
Modified:
maven/archetypes/trunk/maven-archetype-plugin-site/src/main/resources/archetype-resources/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/archetypes/trunk/maven-archetype-plugin-site/src/main/resources/archetype-resources/src/site/site.xml?rev=1825319&r1=1825318&r2=1825319&view=diff
==============================================================================
---
maven/archetypes/trunk/maven-archetype-plugin-site/src/main/resources/archetype-resources/src/site/site.xml
(original)
+++
maven/archetypes/trunk/maven-archetype-plugin-site/src/main/resources/archetype-resources/src/site/site.xml
Sun Feb 25 18:05:38 2018
@@ -47,6 +47,8 @@
<menu name="Samples">
<item name="Sample Changes Report" href="changes-report.html"/>
<item name="Live JIRA Report" href="jira-report.html"/>
+ <item name="Markdown Example" href="markdown.html"/>
+ <item name="Markdown with Velocity Example"
href="markdown-velocity.html"/>
</menu>
<menu name="Examples">
Added:
maven/archetypes/trunk/maven-archetype-site-simple/src/site/markdown/markdown-velocity.md.vm
URL:
http://svn.apache.org/viewvc/maven/archetypes/trunk/maven-archetype-site-simple/src/site/markdown/markdown-velocity.md.vm?rev=1825319&view=auto
==============================================================================
---
maven/archetypes/trunk/maven-archetype-site-simple/src/site/markdown/markdown-velocity.md.vm
(added)
+++
maven/archetypes/trunk/maven-archetype-site-simple/src/site/markdown/markdown-velocity.md.vm
Sun Feb 25 18:05:38 2018
@@ -0,0 +1,13 @@
+Markdown Format with Velocity works
+---------------
+
+#[[###]]# But Markdown conflicts with Velocity on `${esc.h}${esc.h}` syntax
+
+Since `${esc.h}${esc.h}` denotes a
+[single line
comment](http://velocity.apache.org/engine/1.7/vtl-reference.html#single-line-comments)
in Velocity,
+Markdown headers using this syntax are suppressed from generated content.
+
+You can use [unparsed content
syntax](http://velocity.apache.org/engine/1.7/vtl-reference.html#unparsed-content)
+`${esc.h}[[#[[##]]#]]${esc.h}` or
+[escape
tool](http://velocity.apache.org/tools/2.0/apidocs/org/apache/velocity/tools/generic/EscapeTool.html)
+like `${esc.d}{esc.h}${esc.d}{esc.h}`.
Added:
maven/archetypes/trunk/maven-archetype-site-simple/src/site/markdown/markdown.md
URL:
http://svn.apache.org/viewvc/maven/archetypes/trunk/maven-archetype-site-simple/src/site/markdown/markdown.md?rev=1825319&view=auto
==============================================================================
---
maven/archetypes/trunk/maven-archetype-site-simple/src/site/markdown/markdown.md
(added)
+++
maven/archetypes/trunk/maven-archetype-site-simple/src/site/markdown/markdown.md
Sun Feb 25 18:05:38 2018
@@ -0,0 +1,11 @@
+Markdown Format works
+---------------
+
+You can write your documentation in Markdown...
+
+<!-- MACRO{toc|fromDepth=1|toDepth=2} -->
+
+### Subsection
+
+If you want to filter content with Velocity (files ending in `.vm`), please
have a look at
+explanations on [Markdown conflict with Velocity on `##`
syntax](./markdown-velocity.html).
\ No newline at end of file
Added:
maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/fr/markdown/markdown-velocity.md.vm
URL:
http://svn.apache.org/viewvc/maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/fr/markdown/markdown-velocity.md.vm?rev=1825319&view=auto
==============================================================================
---
maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/fr/markdown/markdown-velocity.md.vm
(added)
+++
maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/fr/markdown/markdown-velocity.md.vm
Sun Feb 25 18:05:38 2018
@@ -0,0 +1,13 @@
+Markdown Format with Velocity works
+---------------
+
+#[[###]]# But Markdown conflicts with Velocity on `${esc.h}${esc.h}` syntax
+
+Since `${esc.h}${esc.h}` denotes a
+[single line
comment](http://velocity.apache.org/engine/1.7/vtl-reference.html#single-line-comments)
in Velocity,
+Markdown headers using this syntax are suppressed from generated content.
+
+You can use [unparsed content
syntax](http://velocity.apache.org/engine/1.7/vtl-reference.html#unparsed-content)
+`${esc.h}[[#[[##]]#]]${esc.h}` or
+[escape
tool](http://velocity.apache.org/tools/2.0/apidocs/org/apache/velocity/tools/generic/EscapeTool.html)
+like `${esc.d}{esc.h}${esc.d}{esc.h}`.
Added:
maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/fr/markdown/markdown.md
URL:
http://svn.apache.org/viewvc/maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/fr/markdown/markdown.md?rev=1825319&view=auto
==============================================================================
---
maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/fr/markdown/markdown.md
(added)
+++
maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/fr/markdown/markdown.md
Sun Feb 25 18:05:38 2018
@@ -0,0 +1,11 @@
+Markdown Format works
+---------------
+
+You can write your documentation in Markdown...
+
+<!-- MACRO{toc|fromDepth=1|toDepth=2} -->
+
+### Subsection
+
+If you want to filter content with Velocity (files ending in `.vm`), please
have a look at
+explanations on [Markdown conflict with Velocity on `##`
syntax](./markdown-velocity.html).
\ No newline at end of file
Added:
maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/markdown/markdown-velocity.md.vm
URL:
http://svn.apache.org/viewvc/maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/markdown/markdown-velocity.md.vm?rev=1825319&view=auto
==============================================================================
---
maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/markdown/markdown-velocity.md.vm
(added)
+++
maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/markdown/markdown-velocity.md.vm
Sun Feb 25 18:05:38 2018
@@ -0,0 +1,13 @@
+Markdown Format with Velocity works
+---------------
+
+#[[###]]# But Markdown conflicts with Velocity on `${esc.h}${esc.h}` syntax
+
+Since `${esc.h}${esc.h}` denotes a
+[single line
comment](http://velocity.apache.org/engine/1.7/vtl-reference.html#single-line-comments)
in Velocity,
+Markdown headers using this syntax are suppressed from generated content.
+
+You can use [unparsed content
syntax](http://velocity.apache.org/engine/1.7/vtl-reference.html#unparsed-content)
+`${esc.h}[[#[[##]]#]]${esc.h}` or
+[escape
tool](http://velocity.apache.org/tools/2.0/apidocs/org/apache/velocity/tools/generic/EscapeTool.html)
+like `${esc.d}{esc.h}${esc.d}{esc.h}`.
Added:
maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/markdown/markdown.md
URL:
http://svn.apache.org/viewvc/maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/markdown/markdown.md?rev=1825319&view=auto
==============================================================================
---
maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/markdown/markdown.md
(added)
+++
maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/markdown/markdown.md
Sun Feb 25 18:05:38 2018
@@ -0,0 +1,11 @@
+Markdown Format works
+---------------
+
+You can write your documentation in Markdown...
+
+<!-- MACRO{toc|fromDepth=1|toDepth=2} -->
+
+### Subsection
+
+If you want to filter content with Velocity (files ending in `.vm`), please
have a look at
+explanations on [Markdown conflict with Velocity on `##`
syntax](./markdown-velocity.html).
\ No newline at end of file
Modified:
maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/site.xml?rev=1825319&r1=1825318&r2=1825319&view=diff
==============================================================================
---
maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/site.xml
(original)
+++
maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/site.xml
Sun Feb 25 18:05:38 2018
@@ -28,6 +28,8 @@
<menu name="Examples">
<item name="APT Format" href="format.html"/>
<item name="FAQ" href="faq.html"/>
+ <item name="Markdown Example" href="markdown.html"/>
+ <item name="Markdown with Velocity Example"
href="markdown-velocity.html"/>
<item name="Xdoc Example" href="xdoc.html"/>
</menu>
Modified:
maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/site_fr.xml
URL:
http://svn.apache.org/viewvc/maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/site_fr.xml?rev=1825319&r1=1825318&r2=1825319&view=diff
==============================================================================
---
maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/site_fr.xml
(original)
+++
maven/archetypes/trunk/maven-archetype-site/src/main/resources/archetype-resources/src/site/site_fr.xml
Sun Feb 25 18:05:38 2018
@@ -28,6 +28,8 @@
<menu name="Exemples">
<item name="Format APT" href="format.html"/>
<item name="FAQ" href="faq.html"/>
+ <item name="Exemple Markdown" href="markdown.html"/>
+ <item name="Exemple Markdown avec Velocity"
href="markdown-velocity.html"/>
<item name="Exemple Xdoc" href="xdoc.html"/>
</menu>
Modified: maven/archetypes/trunk/maven-archetype-site/src/site/apt/index.apt.vm
URL:
http://svn.apache.org/viewvc/maven/archetypes/trunk/maven-archetype-site/src/site/apt/index.apt.vm?rev=1825319&r1=1825318&r2=1825319&view=diff
==============================================================================
--- maven/archetypes/trunk/maven-archetype-site/src/site/apt/index.apt.vm
(original)
+++ maven/archetypes/trunk/maven-archetype-site/src/site/apt/index.apt.vm Sun
Feb 25 18:05:38 2018
@@ -29,7 +29,7 @@
${project.name}
<<<${project.artifactId}>>> is an archetype which generates a sample Maven
site which demonstrates
- some of the supported document types like APT, XDoc, and FML and demonstrates
how to i18n your site:
+ some of the supported document types like APT, Markdown, XDoc, and FML and
demonstrates how to i18n your site:
+----+
@@ -48,8 +48,14 @@ project
| | `-- index.apt
| |-- fml
| | `-- faq.fml
+ | |-- markdown
+ | | |-- markdown.md
+ | | `-- markdown-velocity.md.vm
| `-- xdoc
| `-- xdoc.xml
+ |-- markdown
+ | |-- markdown.md
+ | `-- markdown-velocity.md.vm
|-- xdoc
| `-- xdoc.xml
|-- site_fr.xml
