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-site-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new 282aa04b Several site improvements (#1272)
282aa04b is described below
commit 282aa04b919388503381028f43bbd14a65bed990
Author: Konrad Windszus <[email protected]>
AuthorDate: Tue May 19 20:16:48 2026 +0200
Several site improvements (#1272)
Only document site descriptor v2.
Move architecture from "history" to "index".
Use l10n-maven-plugin in a compatible version.
Fix FAQ entry
Add history entry for 3.22.0, remove milestone releases
Clarify deployment
Add documentation about Mermaid diagrams
---
pom.xml | 4 +-
src/site/fml/faq.fml | 12 +--
.../markdown/examples/adding-deploy-protocol.md.vm | 11 ++-
src/site/markdown/examples/mermaid-diagrams.md | 94 ++++++++++++++++++++++
src/site/markdown/examples/sitedescriptor.md | 79 +++++++++---------
src/site/markdown/history.md | 28 +------
src/site/markdown/index.md.vm | 15 +++-
src/site/site.xml | 9 ++-
8 files changed, 169 insertions(+), 83 deletions(-)
diff --git a/pom.xml b/pom.xml
index a34758b5..b8a536f1 100644
--- a/pom.xml
+++ b/pom.xml
@@ -595,9 +595,9 @@ under the License.
<reporting>
<plugins>
<plugin>
- <groupId>com.googlecode.l10n-maven-plugin</groupId>
+ <groupId>org.codehaus.mojo</groupId>
<artifactId>l10n-maven-plugin</artifactId>
- <version>1.8</version>
+ <version>1.2.0</version>
<configuration>
<locales>
<locale>ca</locale>
diff --git a/src/site/fml/faq.fml b/src/site/fml/faq.fml
index 807e6784..366cfe6a 100644
--- a/src/site/fml/faq.fml
+++ b/src/site/fml/faq.fml
@@ -56,12 +56,12 @@ under the License.
<question>How to include a custom Doxia module, like Twiki?</question>
<answer>
<p>
- The site plugin handles out-of-box apt, xdoc and fml formats.
- If you want to use a custom format like Twiki, Simple DocBook, or
XHTML
+ The site plugin handles out-of-box xhtml5, markdown, apt, xdoc and
fml formats.
+ If you want to use a custom format like AsciiDoc
(or any other document format
for which a doxia parser exists, see the list of
<a href="/doxia/references/index.html">Doxia Markup Languages</a>),
- you need to specify the corresponding Doxia module dependency, e.g.
for Twiki:
+ you need to specify the corresponding Doxia module dependency, e.g.
for AsciiDoc:
</p>
<source>
<.
-You can add it either as a [global
extension](/guides/mini/guide-using-extensions.html), or declare it at as a
dependency of the site plugin:
+You can add it either as a [global
extension](/guides/mini/guide-using-extensions.html), or declare it as a
dependency of the site plugin:
```unknown
<project>
@@ -51,10 +51,10 @@ You can add it either as a [global
extension](/guides/mini/guide-using-extension
<artifactId>maven-site-plugin</artifactId>
<version>${project.version}</version>
<dependencies>
- <dependency><!-- add support for ssh/scp -->
+ <dependency><!-- add support for sftp/scp -->
<groupId>org.apache.maven.wagon</groupId>
<artifactId>wagon-ssh</artifactId>
- <version>1.0</version>
+ <version>${wagonVersion}</version>
</dependency>
</dependencies>
</plugin>
@@ -65,3 +65,6 @@ You can add it either as a [global
extension](/guides/mini/guide-using-extension
</project>
```
+Although deployment to SCM (Source Control Management) systems (e.g. SVN, Git,
Mercury) is supported also by [Wagon SCM
provider](/wagon/wagon-providers/wagon-scm/)
+that wagon provider is currently committing each file separately which is not
desirable in the context of site deployment.
+Therefore, it is recommended to use the [Maven SCM Publish
Plugin](https://maven.apache.org/plugins/maven-scm-publish-plugin/) for SCM
deployment instead which pushes all files in a single commit.
diff --git a/src/site/markdown/examples/mermaid-diagrams.md
b/src/site/markdown/examples/mermaid-diagrams.md
new file mode 100644
index 00000000..df6fcd09
--- /dev/null
+++ b/src/site/markdown/examples/mermaid-diagrams.md
@@ -0,0 +1,94 @@
+---
+title: Mermaid Diagrams
+---
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one-->
+<!-- or more contributor license agreements. See the NOTICE file-->
+<!-- distributed with this work for additional information-->
+<!-- regarding copyright ownership. The ASF licenses this file-->
+<!-- to you under the Apache License, Version 2.0 (the-->
+<!-- "License"); you may not use this file except in compliance-->
+<!-- with the License. You may obtain a copy of the License at-->
+<!---->
+<!-- http://www.apache.org/licenses/LICENSE-2.0-->
+<!---->
+<!-- Unless required by applicable law or agreed to in writing,-->
+<!-- software distributed under the License is distributed on an-->
+<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY-->
+<!-- KIND, either express or implied. See the License for the-->
+<!-- specific language governing permissions and limitations-->
+<!-- under the License.-->
+
+# Mermaid Diagrams
+
+Doxia Sitetools can optionally embed the necessary Javascript to render
[Mermaid](https://mermaid.ai/open-source/) diagrams client-side (supported
since [m-site-p
3.22.0](https://github.com/apache/maven-doxia-sitetools/issues/611)).
+
+<!-- MACRO{toc|fromDepth=2} -->
+
+## Setup
+
+In order to enable this feature one has to [add element `mermaid` to the Site
Descriptor](/doxia/doxia-sitetools/doxia-site-model/site.html#mermaid).
+Make sure the site descriptor references namespace 2.1.0 or newer.
+
+### Reference from external CDN
+
+Although an empty element is enough, usually one wants to reference a specific
Mermaid JS version from an external URL instead of embedding that into each
site by yourself and reference it from there.
+
+```xml
+<site xmlns="http://maven.apache.org/SITE/2.1.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; ...>
+ ...
+ <mermaid>
+ <externalJsUrl
integrity="sha384-1CMXl090wj8Dd6YfnzSQUOgWbE6suWCaenYG7pox5AX7apTpY3PmJMeS2oPql4Gk">https://cdn.jsdelivr.net/npm/[email protected]/dist/mermaid.min.js</externalJsUrl>
+ </mermaid>
+
+
+</site>
+```
+
+It is strongly recommended to also set the [`integrity`
attribute](https://developer.mozilla.org/en-US/docs/Web/Security/Defenses/Subresource_Integrity)
in order to ensure the external source delivers exactly the script you expect.
+One can calculate the integrity for a specific Mermaid version with the online
tool provided at <https://srihash.org/>.
+The default external source for Mermaid is
[jsDelivr](https://www.jsdelivr.com/package/npm/mermaid).
+
+Using the [ECMAScript Module (ESM)](https://tc39.es/ecma262/#sec-modules) URL
is not yet supported.
+
+### Embed in generated site
+
+To just embed the hardcoded version of Mermaid into your generated site
([11.13.0 for Doxia
2.1.0](https://github.com/apache/maven-doxia-sitetools/tree/master/doxia-site-renderer/src/main/resources/js))
just leave out the `externalJsUrl` child element.
+
+```xml
+<site xmlns="http://maven.apache.org/SITE/2.1.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; ...>
+ ...
+ <mermaid>
+ ...
+ </mermaid>
+</site>
+```
+
+That way the JS is automatically copied to your site during the rendering and
referenced accordingly in your HTML.
+
+*This should only be necessary if your [site's Content Security Policy
(CSP)](https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/CSP) prevents
including JS from external sources (like for example the global [Apache
CSP](https://infra.apache.org/tools/csp.html))*.
+
+
+## Usage
+
+In order to write Mermaid diagrams, one can just embed them in Doxia sources.
For example to embed something in Markdown (md) write
+
+
+````markdown
+This is my diagram:
+
+```mermaid
+ graph TD;
+ A-->B;
+ A-->C;
+ B-->D;
+ C-->D;
+```
+````
+
+This will be automatically rendered on client side (replacing the Mermaid
source in the HTML page).
+<!-- TODO: add rendering once we use m-site-p 3.22.0 -->
+
+## Configuration
+
+One can further adjust the Mermaid configuration used for rendering with the
[`config` element in the site
descriptor](/doxia/doxia-sitetools/doxia-site-model/site.html#mermaid). Its
format is described in
[MermaidConfig](https://mermaid.ai/open-source/config/setup/mermaid/interfaces/MermaidConfig.html).
\ No newline at end of file
diff --git a/src/site/markdown/examples/sitedescriptor.md
b/src/site/markdown/examples/sitedescriptor.md
index 1045e337..3cc7d5f7 100644
--- a/src/site/markdown/examples/sitedescriptor.md
+++ b/src/site/markdown/examples/sitedescriptor.md
@@ -28,7 +28,7 @@ date: 2011-08-14
You can create your own site descriptor for your project when you want to
override the navigation tree for the site. For example, aside from the
generated reports you want to add additional content to your site. In order for
it to be accessible in the generated site, you must configure your site
descriptor. You create the site descriptor in a file called `site.xml` which
should be located in your `src/site` directory.
-There is a [reference documentation for the site
descriptor](/doxia/doxia-sitetools/doxia-site-model/site.html) available with
its XML Schema.
+There is a [reference documentation for the site descriptor
v2](/doxia/doxia-sitetools/doxia-site-model/site.html) available with its XML
Schema. If you are still leveraging the old site descriptor v1 you should
consider
[migrating](/doxia/doxia-sitetools/doxia-site-model/convert-to-sitedescriptor-2.x.html).
Have a look at the [site descriptor for Maven Site
Plugin](https://github.com/apache/maven-site-plugin/blob/master/src/site/site.xml)
for a real life example.
@@ -40,9 +40,9 @@ The title of each generated page will be a combination of the
_site title_ and t
If you want to use a different site title, but do not want to change the
`<name>` element in your `pom.xml`, you can configure this in your `site.xml`,
like this:
```unknown
-<project name="My Site Title">
+<site name="My Site Title">
...
-</project>
+</site>
```
## Banner
@@ -50,19 +50,17 @@ If you want to use a different site title, but do not want
to change the `<name>
You can include some logos on top of your site, using the following syntax:
```unknown
-<project>
+<site>
...
- <bannerLeft>
- <name>Project Name</name>
- <src>https://maven.apache.org/images/apache-maven-project-2.png</src>
- <href>https://maven.apache.org/</href>
+ <bannerLeft href="https://maven.apache.org";>
+ <image alt="Project Name"
src="https://maven.apache.org/images/apache-maven-project-2.png"; />
</bannerLeft>
<bannerRight>
- <src>https://maven.apache.org/images/maven-logo-2.gif</src>
+ <image src="https://maven.apache.org/images/maven-logo-2.gif"; />
</bannerRight>
...
-</project>
+</site>
```
Refer to the site descriptor
[reference](/doxia/doxia-sitetools/doxia-site-model/site.html) for a complete
tag description.
@@ -72,11 +70,11 @@ Refer to the site descriptor
[reference](/doxia/doxia-sitetools/doxia-site-model
With the out-of-the-box Velocity template, the position of the "Last
Published" date is configurable. By default, the position is on the left
but you can change it. To do this, you can add a `<publishDate>` element to
your `site.xml` like the following:
```unknown
-<project>
+<site>
...
<publishDate position="right"/>
...
-</project>
+</site>
```
The `position` attribute can have one of these values: `left`, `right`,
`navigation-top`, `navigation-bottom`, `bottom`.
@@ -84,11 +82,11 @@ The `position` attribute can have one of these values:
`left`, `right`, `navigat
If you want hide the publish date, you can use this in your `site.xml`:
```unknown
-<project>
+<site>
...
<publishDate position="none"/>
...
-</project>
+</site>
```
The format of the "Last Published" date is the ISO extended date
format that is [recommended by the W3C](http://www.w3.org/QA/Tips/iso-date).
Because the web has an international, cross-cultural audience it is recommended
to _not_ change the date format. There is however a `format` attribute to the
`<publishDate>` element that can be used if you really need a different date
format.
@@ -98,11 +96,11 @@ The format of the "Last Published" date is the
ISO extended date forma
You can show the "Version" of your project on the site, by adding a
`<version>` element to your `site.xml` like this:
```unknown
-<project>
+<site>
...
<version position="right"/>
...
-</project>
+</site>
```
The `position` attribute can have the same values as the `publishDate`
attribute, see above. If the `position` attribute is omitted, the default value
is `left`.
@@ -110,11 +108,11 @@ The `position` attribute can have the same values as the
`publishDate` attribute
If you want hide the version, you can use this in your `site.xml`:
```unknown
-<project>
+<site>
...
<version position="none"/>
...
-</project>
+</site>
```
## "Powered by" Logo
@@ -122,14 +120,15 @@ If you want hide the version, you can use this in your
`site.xml`:
You can add your own "Powered by" logo to your site. To do this, you
add a `<poweredBy>` element in your `site.xml` like this:
```unknown
-<project>
+<site>
...
<poweredBy>
- <logo name="Maven" href="https://maven.apache.org/";
- img="https://maven.apache.org/images/logos/maven-feather.png"/>
+ <logo href="https://maven.apache.org/";>
+ <image
src="https://maven.apache.org/images/logos/maven-feather.png"alt="Maven"/>
+ </logo>
</poweredBy>
...
-</project>
+</site>
```
## Inheritance
@@ -141,7 +140,7 @@ See [ Building multi-module sites](./multimodule.html).
Files in the format-based directory structure can be linked to by their target
HTML filename, e.g. `${basedir}/src/site/apt/foo.apt` and
`${basedir}/src/site/fml/faq.fml` can be linked to via:
```unknown
-<project>
+<site>
...
<body>
...
@@ -152,13 +151,13 @@ Files in the format-based directory structure can be
linked to by their target H
...
</body>
...
-</project>
+</site>
```
There are also several preset menus that can be used in the site descriptor to
include generated content from your project. These are linked via the `ref`
attribute, like so:
```unknown
-<project>
+<site>
...
<body>
...
@@ -166,7 +165,7 @@ There are also several preset menus that can be used in the
site descriptor to i
...
</body>
...
-</project>
+</site>
```
**Note:** The old syntax using `${reports}`, `${parent}` and `${modules}` has
been deprecated and you are encouraged to use the new syntax instead. The
support for the old syntax will be removed in a future version of the Site
Plugin.
@@ -181,7 +180,7 @@ The currently available preset menus are:
You can inject some HTML code into the generated `<head>` element of each page
by adding a head element to the body element of your project's site
descriptor. The following example adds some javascript:
```unknown
-<project>
+<site>
...
<body>
...
@@ -191,7 +190,7 @@ You can inject some HTML code into the generated `<head>`
element of each page b
...
</body>
...
-</project>
+</site>
```
Notice: since Maven Site Plugin version 3\.5, if XHTML content is used, it has
to be escaped, for example through CDATA XML notation. Previously, XML content
didn't need such escaping.
@@ -201,7 +200,7 @@ Notice: since Maven Site Plugin version 3\.5, if XHTML
content is used, it has t
To add links below your site logo, just add a links element to the `<body>`
element of the site descriptor. Each item in the links element will be rendered
as a link in a bar directly below your project's logo.
```unknown
-<project>
+<site>
...
<body>
...
@@ -212,7 +211,7 @@ To add links below your site logo, just add a links element
to the `<body>` elem
...
</body>
...
-</project>
+</site>
```
## Breadcrumbs
@@ -222,7 +221,7 @@ If there exists a logical hierarchy within your site
modules, you may want to ge
To configure breadcrumbs, add a `<breadcrumbs>` element to the `<body>`
element in the site descriptor. Each item element will render a link, and the
items in the `<breadcrumbs>` element will be rendered in order. The breadcrumb
items should be listed from highest level to lowest level.
```unknown
-<project>
+<site>
...
<body>
...
@@ -233,7 +232,7 @@ To configure breadcrumbs, add a `<breadcrumbs>` element to
the `<body>` element
...
</body>
...
-</project>
+</site>
```
**Note** that in a multi-module build, if the parent contains a breadcrumb and
the inheriting site descriptor doesn't, a breadcrumb with the current site
descriptor's name will be added automatically. See the notes on [building
a multi-module site](./multimodule.html) for more details.
@@ -243,7 +242,7 @@ To configure breadcrumbs, add a `<breadcrumbs>` element to
the `<body>` element
You can replace the auto-generated footer content by specifying a custom
`<footer>` element:
```unknown
-<project>
+<site>
...
<body>
...
@@ -251,7 +250,7 @@ You can replace the auto-generated footer content by
specifying a custom `<foote
...
</body>
...
-</project>
+</site>
```
Notice: since Maven Site Plugin version 3\.5, if XHTML content is used, it has
to be escaped, for example through CDATA XML notation. Previously, XML content
didn't need such escaping.
@@ -261,11 +260,11 @@ Notice: since Maven Site Plugin version 3\.5, if XHTML
content is used, it has t
There is also a dummy `<custom>` element then can be used to specify some
arbitrary content. Note that you need to write your own velocity template to
make use of this element, it is ignored by the default Velocity template used
by the Site Plugin.
```unknown
-<project>
+<site>
...
<custom>Custom content</custom>
...
-</project>
+</site>
```
## Skinning
@@ -273,7 +272,7 @@ There is also a dummy `<custom>` element then can be used
to specify some arbitr
Skins can be created to customize the look and feel of a site in a consistent
way. For more information on creating a skin, see [Creating a
Skin](./creatingskins.html). To use a specific skin in your project, you use
the `<skin>` element of the site descriptor. This is a regular artifact or
dependency-like element. For example, to use the [Maven Fluido
Skin](/skins/maven-fluido-skin/), you would include:
```unknown
-<project>
+<site>
...
<skin>
<groupId>org.apache.maven.skins</groupId>
@@ -281,7 +280,7 @@ Skins can be created to customize the look and feel of a
site in a consistent wa
<version>1.8</version>
</skin>
...
-</project>
+</site>
```
**Note:** The `<version>` element is optional and, like plugins, if omitted
the latest version available will be used. It is recommended that you always
specify a version so that your site is reproducible over time.
@@ -297,7 +296,7 @@ The authors of skins have the option to use custom
properties that are unique to
One skin that uses this is the Maven Fluido Skin. There are many examples on
[their site](/skins/maven-fluido-skin/) showing what is possible to do with
custom properties. Here is one example:
```unknown
-<project>
+<site>
...
<custom>
<fluidoSkin>
@@ -306,7 +305,7 @@ One skin that uses this is the Maven Fluido Skin. There are
many examples on [th
</fluidoSkin>
</custom>
...
-</project>
+</site>
```
## Expressions
diff --git a/src/site/markdown/history.md b/src/site/markdown/history.md
index 967f8671..412b6d4f 100644
--- a/src/site/markdown/history.md
+++ b/src/site/markdown/history.md
@@ -24,14 +24,7 @@ date: 2018-01-20
# Maven Site Plugin History
-## Overview
-
-Maven Site Plugin uses:
-
-- [Doxia](/doxia/) to parse [many markup languages](/doxia/references/) then
render HTML: see [Creating Content](./examples/creating-content.html)
documentation for more details \(particularly which markups are enabled by
default in maven-site-plugin and how to add one\),
-- [Doxia Sitetools - Site
Renderer](/doxia/doxia-sitetools/doxia-site-renderer/) to integrate document
content into a template packaged as a skin: see [Creating
Skins](./examples/creatingskins.html) documentation for more details,
-- [Maven Reporting Executor](/shared/maven-reporting-exec/) to manage reports
execution \(since Maven 3; reports execution was managed by Maven itself in
Maven 2: see old [Using maven-site-plugin with
Maven3](https://maven.apache.org/plugins-archives/maven-site-plugin-3.9.0/maven-3.html)
documentation for more details\).
-
+The Maven site plugin leverages certain other modules outlined at
[Architecture](./index.html).
## Maven Site Plugin vs Doxia vs Doxia Sitetools
@@ -41,24 +34,9 @@ Knowing which version of maven-site-plugin uses which
version of Doxia or Doxia
|release date|maven-site-plugin|[Doxia](/doxia/)|[Doxia
Sitetools](/doxia/doxia-sitetools/)|[Maven Reporting
Executor](/shared/maven-reporting-exec/)|minimum Java|minimum Maven|Comment|
|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
+|2026-05|3\.22\.0|2\.1\.0|2\.1\.0|2\.0\.1|||Doxia 2\.1\.0 with support for
Mermaid diagrams|
|2024-10|3\.21\.0|2\.0\.0|2\.0\.0|2\.0\.0|||Doxia 2\.0\.0|
-|2024-08|3\.20\.0|||||||
-|2024-07|4\.0\.0-M16|||||||
-|2024-05|4\.0\.0-M15|2\.0\.0-M12|2\.0\.0-M19|2\.0\.0-M14|8|3\.6\.3||
-|2024-05|4\.0\.0-M14|2\.0\.0-M10|2\.0\.0-M18|2\.0\.0-M13||||
-|2023-12|4\.0\.0-M13|||||||
-|2023-11|4\.0\.0-M12||2\.0\.0-M16|2\.0\.0-M12||||
-|2023-10|4\.0\.0-M11|2\.0\.0-M8|2\.0\.0-M13|2\.0\.0-M11||||
-|2023-10|4\.0\.0-M10||2\.0\.0-M12|2\.0\.0-M10||||
-|2023-07|4\.0\.0-M9|2\.0\.0-M7|2\.0\.0-M11|2\.0\.0-M9||||
-|2023-04|4\.0\.0-M8||2\.0\.0-M10|2\.0\.0-M8||||
-|2023-04|4\.0\.0-M7||2\.0\.0-M7|2\.0\.0-M6||||
-|2023-03|4\.0\.0-M6|2\.0\.0-M6|=|2\.0\.0-M5||||
-|2023-02|4\.0\.0-M5|2\.0\.0-M5|=|2\.0\.0-M4||||
-|2022-12|4\.0\.0-M4|2\.0\.0-M4|=|2\.0\.0-M3||||
-|2022-07|4\.0\.0-M3|||2\.0\.0-M2||||
-|2022-06|4\.0\.0-M2|2\.0\.0-M3|=|||||
-|2022-05|4\.0\.0-M1|2\.0\.0-M2|=|2\.0\.0-M1|8|3\.2\.5|Test of Doxia 2\.0\.0
milestones|
+|2024-08|3\.20\.0|2\.0\.0-M12|2\.0\.0-M19|2\.0\.0-M14||3\.6\.3|Doxia 2\.0\.0
(still based on non-final milestone releases)|
|2022-07|3\.12\.1|||||||
|2022-04|3\.12\.0||||8|3\.2\.5||
|2022-02|3\.11\.0|||1\.6\.0||||
diff --git a/src/site/markdown/index.md.vm b/src/site/markdown/index.md.vm
index fbdc550c..95e40eeb 100644
--- a/src/site/markdown/index.md.vm
+++ b/src/site/markdown/index.md.vm
@@ -28,18 +28,28 @@ The Site Plugin is used to generate a site for the project.
The generated site a
Please read the [migration guide](./migrate.html) if you want to upgrade from
a previous version.
+#[[##]]# Architecture
+
+The Site Plugin uses:
+
+- [Doxia](/doxia/) to parse [many markup languages](/doxia/references/) then
render HTML: see [Creating Content](./examples/creating-content.html)
documentation for more details \(particularly which markups are enabled by
default in maven-site-plugin and how to add one\),
+- [Doxia Sitetools - Site
Renderer](/doxia/doxia-sitetools/doxia-site-renderer/) to integrate document
content into a template packaged as a skin: see [Creating
Skins](./examples/creatingskins.html) documentation for more details,
+- [Maven Reporting Executor](/shared/maven-reporting-exec/) to manage reports
execution \(since Maven 3\).
+
+
#[[##]]# Goals Overview
-The Site Plugin has seven goals:
+The Site Plugin has the following goals:
- [site:site](./site-mojo.html) is used generate a site for a single project.
Note that links between module sites in a multi module build will **not** work,
since local build directory structure doesn't match deployed site.
- [site:deploy](./deploy-mojo.html) is used to deploy the generated site using
Wagon supported protocol to the site URL specified in the
`<distributionManagement>` section of the POM.
-- [site:run](./run-mojo.html) starts the site up, rendering documents as
requested for faster editing. It uses Jetty as the web server.
+- [site:run](./run-mojo.html) starts a server, rendering documents on-demand
(while requested) for faster previews. It uses Jetty as the web server.
- [site:stage](./stage-mojo.html) generates a site in a local staging or mock
directory based on the site URL specified in the `<distributionManagement>`
section of the POM. It can be used to test that links between module sites in a
multi module build work. This goal requires the site to already have been
generated using the site goal, such as by calling `mvn site`.
- [site:stage-deploy](./stage-deploy-mojo.html) deploys the generated site to
a staging or mock directory to the site URL specified in the
`<distributionManagement>` section of the POM.
- [site:attach-descriptor](./attach-descriptor-mojo.html) adds the site
descriptor \(`site.xml`\) to the list of files to be installed/deployed. For
more references of the site descriptor, [here's a
link](./examples/sitedescriptor.html).
- [site:jar](./jar-mojo.html) bundles the site output into a JAR so that it
can be deployed to a repository.
- [site:effective-site](./effective-site-mojo.html) calculates the effective
site descriptor, after inheritance and interpolation.
+- [site:auto-refresh](./auto-refresh-mojo.html) renders the site once and then
watches for changes in the source files. If a change is detected, the Doxia
source will be re-rendered.
#[[##]]# Usage
@@ -55,6 +65,7 @@ The following examples show how to use the Site Plugin in
more advanced use case
- [Creating Content](./examples/creating-content.html)
- [Configuring the Site Descriptor](./examples/sitedescriptor.html)
+- [Using Mermaid Diagrams](./examples/mermaid-diagrams.html)
- [Configuring Site Run](./examples/siterun.html)
- [Excluding Document Formats](./examples/moduleexcludes.html)
diff --git a/src/site/site.xml b/src/site/site.xml
index 72b4a1b3..4366ffbb 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -19,9 +19,9 @@ specific language governing permissions and limitations
under the License.
-->
-<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
- xmlns="http://maven.apache.org/DECORATION/1.6.0";
- xsi:schemaLocation="http://maven.apache.org/DECORATION/1.6.0
http://maven.apache.org/xsd/decoration-1.6.0.xsd";>
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd";>
+ <!-- TODO: enable mermaid when rendering with m-site-p 3.22.0 -->
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
@@ -44,6 +44,7 @@ under the License.
<item name="Excluding Document Formats"
href="/examples/moduleexcludes.html"/>
<item name="Inheritance of the Site Distribution Management"
href="/examples/inheritance-site-distribution-management.html"/>
+ <item name="Mermaid Diagrams" href="/examples/mermaid-diagrams.html"/>
</menu>
<menu name="Reports">
@@ -60,4 +61,4 @@ under the License.
<item name="Deploying to sourceforge.net"
href="/examples/site-deploy-to-sourceforge.net.html"/>
</menu>
</body>
-</project>
+</site>
![https://maven.apache.org/images/apache-maven-project-2.png"](https://maven.apache.org/images/apache-maven-project-2.png"){kind=link}
![https://maven.apache.org/images/maven-logo-2.gif"](https://maven.apache.org/images/maven-logo-2.gif"){kind=link}
![https://maven.apache.org/images/logos/maven-feather.png"/](https://maven.apache.org/images/logos/maven-feather.png"/){kind=link}
![https://maven.apache.org/images/logos/maven-feather.png"alt="Maven"/](https://maven.apache.org/images/logos/maven-feather.png"alt="Maven"/){kind=link}