You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-commits@maven.apache.org by sv...@apache.org on 2026/08/09 22:23:06 UTC
svn commit: r1937015 - in maven/website/content/guides: development mini
Author: svn-site-role
Date: Sun Aug 9 22:23:06 2026
New Revision: 1937015
Log:
Site checkin for project Apache Maven Site
Modified:
maven/website/content/guides/development/guide-plugin-documentation.html
maven/website/content/guides/mini/guide-site.html
Modified: maven/website/content/guides/development/guide-plugin-documentation.html
==============================================================================
--- maven/website/content/guides/development/guide-plugin-documentation.html Sun Aug 9 21:08:48 2026 (r1937014)
+++ maven/website/content/guides/development/guide-plugin-documentation.html Sun Aug 9 22:23:06 2026 (r1937015)
@@ -299,56 +299,55 @@ public class ExampleMojo
<li>
<p>Introduction</p>
-<p>The introduction is the front page of the plugin documentation. This is a good place to put any section and pages that need to be emphasized. The generated plugin parameter configuration should be linked here. Below is the suggested <code>src/site/apt/index.apt</code> template:</p>
+<p>The introduction is the front page of the plugin documentation. This is a good place to put any section and pages that need to be emphasized. The generated plugin parameter configuration should be linked here. Below is the suggested <code>src/site/markdown/index.md</code> template:</p>
-<pre><code class="nohighlight nocode"> ------
- Introduction
- ------
- Author
- ------
- YYYY-MM-DD
- ------
+<pre class="prettyprint linenums"><code class="language-markdown">
+---
+title: Introduction
+author:
+ - Author
+date: YYYY-MM-DD
+---
+# Plugin Name
-Plugin Name
+Plugin introduction, description, and other relevant information.
- Plugin introduction, description, and other relevant information.
+## Goals Overview
-* Goals Overview
+General information about the goals.
- General information about the goals.
+- [prefix:goal](<goal>.html) short description for this plugin goal.
- * {{{<goal>.html}prefix:goal}} short description for this plugin goal.
+## Usage
-* Usage
+General instructions for using the Plugin Name can be found on the [usage page](usage.html). Some more
+specific use cases are described in the examples given below. Last but not least, users occasionally contribute
+additional examples, tips or errata to the plugin's wiki page.
- General instructions for using the Plugin Name can be found on the {{{usage.html}usage page}}. Some more
- specific use cases are described in the examples given below. Last but not least, users occasionally contribute
- additional examples, tips or errata to the plugin's wiki page.
+If you have questions regarding the plugin, consult the [FAQ](faq.html) and feel
+free to contact the [user mailing list](mailing-lists.html). Posts to the mailing list are archived and might
+already contain the answer to your question. Hence, it is also worth browsing/searching
+the [mail archive](mailing-lists.html).
- If you have questions regarding the plugin, consult the {{{faq.html}FAQ}} and feel
- free to contact the {{{mailing-lists.html}user mailing list}}. Posts to the mailing list are archived and might
- already contain the answer to your question. Hence, it is also worth browsing/searching
- the {{{mailing-lists.html}mail archive}}.
+If you think the plugin is missing a feature or has a defect, you can file a feature request or bug report in the
+[issue management system](issue-management.html). When creating a new issue, please provide a comprehensive description of your
+concern. Especially for fixing bugs, it is crucial that the developers can reproduce your problem. For this reason,
+entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated.
+Of course, patches are welcome, too. Contributors can check out the project from our
+[source repository](scm.html) and will find supplementary information in the
+[guide to helping with Maven](/guides/development/guide-helping.html).
- If you think the plugin is missing a feature or has a defect, you can file a feature request or bug report in the
- {{{issue-management.html}issue management system}}. When creating a new issue, please provide a comprehensive description of your
- concern. Especially for fixing bugs, it is crucial that the developers can reproduce your problem. For this reason,
- entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated.
- Of course, patches are welcome, too. Contributors can check out the project from our
- {{{scm.html}source repository}} and will find supplementary information in the
- {{{/guides/development/guide-helping.html}guide to helping with Maven}}.
+## Examples
-* Examples
+To help you understand some usages of the Plugin Name,
+you can take a look at the following examples:
- To help you understand some usages of the Plugin Name,
- you can take a look at the following examples:
+- [Example Description One](./examples/example-one.html)
+- [Example Description Two](./examples/example-two.html)
- * {{{./examples/example-one.html}Example Description One}}
-
- * {{{./examples/example-two.html}Example Description Two}}
-
-</code></pre></li>
+</code></pre>
+<p>The <code>---</code> block at the top carries the page title, author and date; the site skin turns them into the document title and its <code>author</code> and <code>date</code> meta tags. If the page needs Velocity — to interpolate a version into an example POM, say — name it <code>index.md.vm</code> instead, and keep headings below level one away from ` line comment.</p></li>
<li>
<p>Goals</p>
<p><code>plugin-info.html</code> is generated by the Maven Plugin Report Plugin. Until the Maven Site Plugin is updated it would be better to pull it out to the main menu for greater visibility. This contains the goals and their descriptions with a link to the configuration parameters. The information is based on the comments and annotations of the plugin.</p></li>
Modified: maven/website/content/guides/mini/guide-site.html
==============================================================================
--- maven/website/content/guides/mini/guide-site.html Sun Aug 9 21:08:48 2026 (r1937014)
+++ maven/website/content/guides/mini/guide-site.html Sun Aug 9 22:23:06 2026 (r1937015)
@@ -170,11 +170,11 @@
<pre><code class="nohighlight nocode">+- src/
+- site/
- +- apt/
- | +- index.apt
- !
+- markdown/
- | +- content.md
+ | +- index.md
+ |
+ +- apt/
+ | +- content.apt
|
+- fml/
| +- general.fml
@@ -189,8 +189,8 @@
<p>Let's take a look at the examples of the various document types:</p>
<ul>
-<li><code>apt</code>: the APT format, “Almost Plain Text”, is a wiki-like format that allows you to write simple, structured documents (like this one) very quickly. A full reference of the <a href="/doxia/references/apt-format.html">APT Format</a> is available,</li>
-<li><code>markdown</code>: the well known <a href="https://en.wikipedia.org/wiki/Markdown" class="externalLink">Markdown</a> format,</li>
+<li><code>markdown</code>: the well known <a href="https://en.wikipedia.org/wiki/Markdown" class="externalLink">Markdown</a> format, and the one this page is written in. It is what new documentation should use,</li>
+<li><code>apt</code>: the APT format, “Almost Plain Text”, a wiki-like format that predates Maven's support for Markdown. It is still supported, but the Maven project itself has moved its own documentation off it; see the <a href="/doxia/references/apt-format.html">APT Format</a> reference if you are maintaining an existing page, and <a href="/doxia/doxia-tools/doxia-converter/">doxia-converter</a> if you would like to convert one,</li>
<li><code>fml</code>: the FML format is the <a href="/doxia/references/fml-format.html">FAQ format</a>,</li>
<li><code>xdoc</code>: an XML document conforming to a small and simple set of tags, see the <a href="/doxia/references/xdoc-format.html">full reference</a>.</li>
</ul>