This is an automated email from the ASF dual-hosted git repository.
slachiewicz 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 4db7ac70 Move the site creation guides to maven-site
4db7ac70 is described below
commit 4db7ac702400d17d3b47d123f9468990f2b67323
Author: Sylwester Lachiewicz <[email protected]>
AuthorDate: Sat Oct 31 20:04:24 2026 +0000
Move the site creation guides to maven-site
---
src/site/markdown/examples/creating-content.md.vm | 179 ----------------------
src/site/markdown/examples/creatingskins.md | 67 --------
src/site/markdown/examples/filtering-content.md | 100 ------------
src/site/markdown/examples/mermaid-diagrams.md | 96 ------------
src/site/markdown/examples/multimodule.md | 103 -------------
src/site/markdown/examples/sitedescriptor.md | 8 +-
src/site/markdown/i18n.md | 30 ----
src/site/markdown/index.md.vm | 12 +-
src/site/markdown/usage.md | 2 +-
src/site/site.xml | 13 +-
10 files changed, 17 insertions(+), 593 deletions(-)
diff --git a/src/site/markdown/examples/creating-content.md.vm
b/src/site/markdown/examples/creating-content.md.vm
deleted file mode 100644
index 8426188e..00000000
--- a/src/site/markdown/examples/creating-content.md.vm
+++ /dev/null
@@ -1,179 +0,0 @@
----
-title: Creating Content
-author:
- - Dennis Lundberg
-date: 2009-03-08
----
-
-<!--
-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.
--->
-
-# Creating Content
-
-Now it's time to create some content for your site. Site content is
structured by format, as several formats are supported.
-
-<!-- MACRO{toc|section=1|fromDepth=2|toDepth=3} -->
-
-#[[##]]# Documentation formats
-
-Here's an example of a directory structure for a site:
-
-```
-+- src/
- +- site/
- +- apt/
- | +- index.apt
- |
- +- fml/
- | +- general.fml
- | +- faq.fml
- |
- +- markdown/
- | +- markup.md
- |
- +- xdoc/
- | +- other.xml
- |
- +- xhtml/
- | +- xhtml-content.xhtml
- |
- +- site.xml
-```
-
-The `${basedir}/src/site` directory which contains a site descriptor along
with various directories corresponding to the supported document formats.
Let's take a look at examples of the various document formats.
-
-- APT: 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 [ APT
Format](/doxia/references/apt-format.html) is available.
-- FML: The FML format is the FAQ format. This is the same that were used in
Maven 1\.x. For more info about the [FML
Format](/doxia/references/fml-format.html) check the [Doxia](/doxia/) site.
-- XDoc: The XDoc format is the same as [ used in Maven
1\.x](/maven-1.x/using/site.html). A reference for the [ XDoc
Format](/doxia/references/xdoc-format.html) is available.
-- Markdown (since maven-site-plugin 3\.3): [
Markdown](http://en.wikipedia.org/wiki/Markdown) is a widespread Markup
language.
-
-Other formats are available, but the above four are recognized by default by
the site plugin. Any other document format for which a Doxia parser exists can
be used as well (see the list of [Doxia Markup
Languages](/doxia/references/index.html)), but in this case you need to add the
corresponding Doxia dependency to your site plugin configuration, as explained
in the last paragraph. Note that Doxia also supports several output formats,
the site plugin only creates XHTML5\.
-
-Note that all of the above is optional - just one index file is required in
one of the input trees. The paths under each format will be merged together to
form the root directory of the site. After running '`mvn site:site`'
on the example above you will end up with this in your `target` directory:
-
-```
-+- target/
- +- site/
- +- css/
- |
- +- images/
- |
- +- index.html
- +- general.html
- +- faq.html
- +- other.html
- +- xhtml-content.html
-```
-
-This means that `/src/site/apt/index.apt` will be available in the site as
`/index.html`. So, in [ your site descriptor](./sitedescriptor.html) you might
link to `/index.html` and `/other.html`, where the source of these two files
would be `/src/site/apt/index.apt` and `/src/site/xdoc/other.xdoc`.
-
-The `css` and `images` directories contain stylesheets and images from the
skin being used. You can read more about skins in [the site descriptor
documentation](./sitedescriptor.html).
-
-#[[##]]# Adding Extra Resources
-
-You can add any arbitrary resource to your site by including them in a
`resources` directory as shown below. Additional CSS files can be picked up
when they are placed in the `css` directory within the `resources` directory.
-
-```
-+- src/
- +- site/
- +- resources/
- +- css/
- | +- site.css
- |
- +- images/
- +- pic1.jpg
-```
-
-The file `site.css` will be added to the default XHTML5 output, so it can be
used to adjust the default Maven stylesheets if desired.
-
-The file `pic1.jpg` will be available via a relative reference to the `images`
directory from any page in your site.
-
-#[[##]]# Templating
-
-To add simple logic to your content (for example to filter properties) add a
`.vm` extension to the filename (this is valid for all supported formats).
-
-**Note:** [Apache Velocity](http://velocity.apache.org/) is used as templating
engine.
-
-For example, the module for the Maven website contains a
[`content/xdoc/download.xml.vm`](https://github.com/apache/maven-site/blob/master/content/xdoc/download.xml.vm)
file, which uses the expression `${currentStableVersion}` to filter in a
property set in the
[POM](http://svn.apache.org/repos/asf/maven/site/trunk/pom.xml).
-
-Some properties are defined by default: see [Doxia Site Renderer's
Velocity processing
reference](/doxia/doxia-sitetools/doxia-site-renderer/#Velocity_processing) for
more information. For a complete usage overview, see Velocity's [user
guide](http://velocity.apache.org/engine/devel/user-guide.html).
-
-Since version 3\.5, you can save processed markup by setting
`saveProcessedContent` to `true`: see [corresponding
documentation](../site-mojo.html#saveProcessedContent) for more details.
-
-For simple property replacement consider using [Maven
Filtering](./filtering-content.html) instead of Velocity templating (also to
avoid the common issues described below).
-
-#[[###]]# Common Issues and Workarounds
-
-- **dotted properties**:
-
- As Velocity uses a dot-notation to traverse beans, you **cannot** use
dotted properties defined in `<properties>` directly.
-
- It is generally advised to access properties by using the
`${esc.d}context` tool: e.g., with `${esc.d}context.get("my.property")`.
-
-- **Markdown conflict with Velocity on #[[##]]# syntax**:
-
- Since `#[[##]]#` denotes a [single line
comment](https://velocity.apache.org/engine/2.3/vtl-reference.html#single-line-comments)
in Velocity, Markdown headers using this syntax are suppressed from generated
content.
-
- You can use [unparsed content
syntax](https://velocity.apache.org/engine/2.3/vtl-reference.html#unparsed-content)
`${esc.h}[[#[[##]]#]]${esc.h}` or [escape
tool](https://velocity.apache.org/tools/3.1/apidocs/org/apache/velocity/tools/generic/EscapeTool.html)
like `${esc.d}{esc.h}${esc.d}{esc.h}`.
-
-#[[##]]# Internationalization
-
-Internationalization in Maven is very simple, as long as the reports you are
using have that particular locale defined. For an overview of supported
languages and instructions on how to add further languages, please see the
related article [ Internationalization](../i18n.html).
-
-To enable multiple locales, or languages, add a configuration similar to the
following to your POM:
-
-```xml
-<project>
- ...
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-site-plugin</artifactId>
- <version>${project.version}</version>
- <configuration>
- <locales>default,fr</locales>
- </configuration>
- </plugin>
- </plugins>
- </build>
- ...
-</project>
-```
-
-This will generate both a default (`Locale#ROOT`) and a French version of the
site. It will be generated at the root of the site, with a copy of the French
translation of the site in the `fr/` subdirectory.
-
-To add your own content for that translation instead of using the default,
create a subdirectory with that locale's name in your site directory and
create a new site descriptor with the name of the locale in the file name. For
example:
-
-```
-+- src/
- +- site/
- +- apt/
- | +- index.apt (Default version)
- |
- +- fr/
- | +- apt/
- | +- index.apt (French version)
- |
- +- site.xml (Default site descriptor)
- +- site_fr.xml (French site descriptor)
-```
-
-With one site descriptor per language, the translated site(s) can evolve
independently.
-
diff --git a/src/site/markdown/examples/creatingskins.md
b/src/site/markdown/examples/creatingskins.md
deleted file mode 100644
index 5c9a2984..00000000
--- a/src/site/markdown/examples/creatingskins.md
+++ /dev/null
@@ -1,67 +0,0 @@
----
-title: Creating Skins
-author:
- - Brett Porter
- - Dennis Lundberg
-date: 2009-03-08
----
-
-<!--
-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.
--->
-
-# Creating Skins
-
-If you want to tune the way your site looks, you can use a custom skin to
provide your own CSS stylesheets. If that is still not enough, you can even
tweak the output templates that Maven uses to generate the site documentation.
-
-For an in-depth discussion of site customization, please have a look at [
Maven: The Complete Reference, Chapter 10\. Site
Generation](http://books.sonatype.com/mvnref-book/reference/site-generation.html)
provided by Sonatype.
-
-## About
-
-A skin contains the following elements:
-
-- Resources to copy into each project (such as images used by the CSS)
-- A couple of CSS files, containing the visual styling
-- A Velocity template in `/META-INF/maven/site.vm` for an alternate HTML
rendering of the site.
-- Since Maven Site Plugin 3\.5, an optional [skin
descriptor](/doxia/doxia-sitetools/doxia-skin-model/index.html) in
`/META-INF/maven/skin.xml` containing meta-data about the skin
-## Maven Site Skin Archetype
-
-[`maven-archetype-site-skin`
archetype](/archetypes/maven-archetype-site-skin/) can be used to easily create
a complete new skin project, including its dedicated `/META-INF/maven/site.vm`.
-
-## Building
-
-A skin is built like any other JAR - with a `packaging` of `jar`. No
additional plugins are needed.
-
-Resources should be put in the normal `src/main/resources` directory.
-
-Once the JAR is built and deployed, it can be used by projects.
-
-## Constructing the CSS
-
-<!-- @todo More information is needed here on constructing the CSS-->
-
-If you are interested in constructing your own CSS, it is recommended that you
copy the file
[`maven-theme.css`](https://github.com/apache/maven-fluido-skin/tree/master/src/main/resources/css/maven-theme.css)
from Maven Fluido Skin and modify it to suit your needs.
-
-## Customizing the HTML Output with a Velocity Template
-
-The format of the Velocity template is currently out of scope for this
document.
-
-For more information about how to write Velocity templates see the [Velocity
User Guide](https://velocity.apache.org/engine/2.3/user-guide.html) and
[Velocity Template Language Reference
Guide](https://velocity.apache.org/engine/2.3/vtl-reference.html).
-
-Notice that Velocity 2\.3 is used since Maven Site Plugin 4\.0\.0-M2, but
version 1\.7 was used previously.
-
diff --git a/src/site/markdown/examples/filtering-content.md
b/src/site/markdown/examples/filtering-content.md
deleted file mode 100644
index 0e462ae4..00000000
--- a/src/site/markdown/examples/filtering-content.md
+++ /dev/null
@@ -1,100 +0,0 @@
-<!--
-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.
--->
-
-# Overview
-
-Although sophisticated logic inside content can be implemented with [Apache
Velocity Templates](creating-content.html#templating) this has the drawback that
-
-- not everyone is familiar with the Apache Velocity syntax
-- web-based UI/preview (e.g. in GitHub) does not work
-- there is conflicts between Velocity and Markdown syntax which both use `##`
for different purposes and
-- Velocity overhead is way too big for performing simple property interpolation
-
-Therefore for simple property interpolation regular [Maven
filtering](https://maven.apache.org/plugins/maven-resources-plugin/examples/filter.html)
is often more suitable.
-
-# Setup
-
-## Filter prior site creation
-
-In order to perform Maven filtering create a dedicated source directory which
is processed by
[`maven-resources-plugin:copy-resources`](https://maven.apache.org/plugins/maven-resources-plugin/copy-resources-mojo.html).
-That should be executed prior to the site creation.
-In the following example the directory `src/site` is copied with filtering to
`/target/site-src`:
-
-```xml
-<project>
- ...
- <build>
- <plugins>
- <plugin>
- <!-- prepare site content by filtering ${project.*} values -->
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-resources-plugin</artifactId>
- <executions>
- <execution>
- <id>filter-site</id>
- <phase>pre-site</phase>
- <goals>
- <goal>copy-resources</goal>
- </goals>
- <configuration>
-
<outputDirectory>${project.build.directory}/site-src</outputDirectory>
- <resources>
- <resource>
- <directory>src/site</directory>
- <filtering>true</filtering>
- </resource>
- </resources>
- </configuration>
- </execution>
- </executions>
- </plugin>
- ...
- </plugins>
- ...
- </build>
- ...
-</project>
-```
-
-## Adjust site source
-
-In order to generate the site from the filtered sources (after interpolation
has been applied) adjust the [site source
directory](../site-mojo.html#siteDirectory). In addition you should adjust the
[site source being used for the edit
buttons](../site-mojo.html#alternativeSiteSourceDirectories).
-
-```xml
-<project>
- ...
- <build>
- <plugins>
- ...
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-site-plugin</artifactId>
- <configuration>
- ...
- <siteDirectory>${project.build.directory}/site-src</siteDirectory>
-
<alternativeSiteSourceDirectories>${basedir}/src/site</alternativeSiteSourceDirectories>
- </configuration>
- </plugin>
- ...
- </plugins>
- ...
- </build>
- ...
-</project>
-```
diff --git a/src/site/markdown/examples/mermaid-diagrams.md
b/src/site/markdown/examples/mermaid-diagrams.md
deleted file mode 100644
index 640de60a..00000000
--- a/src/site/markdown/examples/mermaid-diagrams.md
+++ /dev/null
@@ -1,96 +0,0 @@
----
-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/multimodule.md
b/src/site/markdown/examples/multimodule.md
deleted file mode 100644
index d314991c..00000000
--- a/src/site/markdown/examples/multimodule.md
+++ /dev/null
@@ -1,103 +0,0 @@
----
-title: Multi-module Sites
-author:
- - Vincent Siveton
- - Maria Odea Ching
- - Dennis Lundberg
- - Lukas Theussl
-date: 2011-01-18
----
-
-<!--
-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.
--->
-
-# Building multi-module sites
-
-When running `mvn site` on a top level project, Maven will build all sites for
every module defined in the `modules` section of the pom individually. Note
that each site is generated in each individual project's target location.
As a result, relative links between different modules will NOT work. They will
however work when you deploy or stage the site.
-
-## Staging and deploying
-
-To preview the whole tree of a multi-module site, you can use the
[`site:stage`](../stage-mojo.html) goal. This will copy individual sites to
their proper place at the staging location.
-
-[`site:deploy`](../deploy-mojo.html) does the same thing as `site:stage`, but
uses the url defined in the `<distributionManagement>` element of the pom as
deployment location. This is usually a remote url, but both remote protocols
like `scp` and local protocols like `file` are supported.
-
-Finally, [`site:stage-deploy`](../stage-deploy-mojo.html) does the same thing
as `site:deploy` but uses the `stagingDirectory` parameter as deployment
location. This can be used to deploy the site to a remote staging area
(`site:stage` is always local).
-
-**Notes:**
-
-- If subprojects inherit the (distribution) site URL from a parent POM, they
will automatically append their _artifactId_ to form their effective deployment
location. This goes for both the project url and the url defined in the
`<distributionManagement>` element of the pom.
-- If your multi-module tree does not follow the Maven conventions, or if
module directories are named differently than module artifacts, you have to
specify the url's for **each** child project. See also [`How does the Site
Plugin use the <url> element in the POM?`](../faq.html#Use_of_url).
-- The pom.xml of the topmost project in a multi-module build must define the
distributionManagement URL element (called "rootURL" hereafter). The
rootURL must be the topmost distributionManagement URL in the multi-module
project, implying that any distributionManagement URL defined within another
project in a multimodule build must start with the rootURL and append unique
paths (to be situated "below" the rootURL).
-- All projects in multi-module builds must define unique
distributionManagement url elements, below/under the root
distributionManagement URL in terms of URL path.
-- If the artifactId and module name (i.e. directory name) are not identical
for any project within a multi-module build, the distributionManagement URL
element must be defined in the pom.xml file in the project.
-## Inheritance
-
-Site descriptors are inherited along the same lines as project descriptors
are. If you want your project's site descriptor to be inherited, you need
to attach it to the project's main artifact. You use the
[`site:attach-descriptor`](../attach-descriptor-mojo.html) goal to attach the
site descriptor to your project's main artifact.
-
-In Maven 3 you must attach the site descriptor yourself, even for projects
with packaging set to "pom".
-
-By default, all the parent descriptor settings are inherited with the only
exception of menus, see below. From the body, the links and breadcrumbs
accumulate to contain all the parent's site descriptor links and
breadcrumbs. If the parent contains some breadcrumb and the inheriting site
descriptor doesn't, a breadcrumb with the current site descriptor's
name will be added automatically.
-
-However, it is possible to inherit menus as well. To do so, use the `inherit`
attribute in the site descriptor. This can be either `top` or `bottom`,
indicating where the inherited menu will be placed. For example:
-
-```xml
-<project>
- ...
- <body>
- ...
- <menu name="My Inherited Menu" inherit="top">
- ...
- </menu>
- ...
- </body>
- ...
-</project>
-```
-
-## Aggregate Reports
-
-Some reports can be run against the sum of every modules: these are aggregate
reports. This is the case of maven-javadoc-plugin, maven-jxr-plugin or
maven-checkstyle-plugin.
-
-To benefit from aggregate reports, you must configure a reportSet in the
parent pom, and turn inheritance off to avoid the aggregate report to be run in
modules. For example, with maven-jxr-report:
-
-```xml
-<project>
- ...
- <reporting>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-jxr-plugin</artifactId>
- <version>2.3</version>
- <reportSets>
- <reportSet>
- <id>aggregate</id>
- <inherited>false</inherited>
- <reports>
- <report>aggregate</report>
- </reports>
- </reportSet>
- </reportSets>
- </plugin>
- </plugins>
- </reporting>
- ...
-</project>
-```
-
diff --git a/src/site/markdown/examples/sitedescriptor.md
b/src/site/markdown/examples/sitedescriptor.md
index 418f667a..166ba349 100644
--- a/src/site/markdown/examples/sitedescriptor.md
+++ b/src/site/markdown/examples/sitedescriptor.md
@@ -135,7 +135,7 @@ You can add your own "Powered by" logo to your
site. To do this, you a
## Inheritance
-See [ Building multi-module sites](./multimodule.html).
+See [ Building multi-module
sites](https://maven.apache.org/guides/mini/guide-multimodule-site.html).
## Including Generated Content
@@ -237,7 +237,7 @@ To configure breadcrumbs, add a `<breadcrumbs>` element to
the `<body>` element
</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.
+**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](https://maven.apache.org/guides/mini/guide-multimodule-site.html) for
more details.
## Custom footer
@@ -271,7 +271,7 @@ There is also a dummy `<custom>` element then can be used
to specify some arbitr
## Skinning
-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:
+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](https://maven.apache.org/skins/#Creating_a_skin). 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:
```xml
<site>
@@ -320,5 +320,5 @@ Expressions can be:
- ${project.properties}, for instance `${myProperty}` referenced in `
<project><properties><myProperty> `
- ${environmentVariable}, for instance `${JAVA_HOME}`
-**Note:**There are additional restrictions on using dotted project properties
in content pages. See [Filtering](./creating-content.html#Filtering) for
details on injecting properties into content pages.
+**Note:**There are additional restrictions on using dotted project properties
in content pages. See [Using Properties in
Content](https://maven.apache.org/guides/mini/guide-site.html#Using_Properties_in_Content)
for details on injecting properties into content pages.
diff --git a/src/site/markdown/i18n.md b/src/site/markdown/i18n.md
deleted file mode 100644
index d626cb24..00000000
--- a/src/site/markdown/i18n.md
+++ /dev/null
@@ -1,30 +0,0 @@
----
-title: Internationalization
-author:
- - Vincent Siveton
- - Dennis Lundberg
----
-
-<!--
-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.
--->
-
-# Internationalization
-
-The documentation about internationalization and localization of plugins has
been moved to:
[http://maven.apache.org/plugins/localization.html](/plugins/localization.html)
-
diff --git a/src/site/markdown/index.md.vm b/src/site/markdown/index.md.vm
index c7baa909..ef1ff37e 100644
--- a/src/site/markdown/index.md.vm
+++ b/src/site/markdown/index.md.vm
@@ -34,8 +34,8 @@ Please read the [migration guide](./migrate.html) if you want
to upgrade from a
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,
+- [Doxia](/doxia/) to parse [many markup languages](/doxia/references/) then
render HTML: see [Creating a
site](https://maven.apache.org/guides/mini/guide-site.html) guide 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 a
skin](https://maven.apache.org/skins/#Creating_a_skin) for more details,
- [Maven Reporting Executor](/shared/maven-reporting-exec/) to manage reports
execution (since Maven 3).

@@ -66,20 +66,20 @@ If you feel like the plugin is missing a feature or has a
defect, you can file a
The following examples show how to use the Site Plugin in more advanced use
cases:
-- [Creating Content](./examples/creating-content.html)
+- [Creating
Content](https://maven.apache.org/guides/mini/guide-site.html#Creating_Content)
- [Configuring the Site Descriptor](./examples/sitedescriptor.html)
-- [Using Mermaid Diagrams](./examples/mermaid-diagrams.html)
+- [Using Mermaid
Diagrams](https://maven.apache.org/doxia/mermaid-diagrams.html)
- [Configuring Site Run](./examples/siterun.html)
- [Excluding Document Formats](./examples/moduleexcludes.html)
#[[###]]# Reports
- [Configuring Reports](./examples/configuring-reports.html)
-- [Reports Internationalization](./i18n.html)
+- [Reports
Internationalization](https://maven.apache.org/plugins/localization.html)
#[[###]]# Site Template
-- [Creating Skins](./examples/creatingskins.html)
+- [Creating Skins](https://maven.apache.org/skins/#Creating_a_skin)
#[[###]]# Deploying
diff --git a/src/site/markdown/usage.md b/src/site/markdown/usage.md
index fa3ab9e2..6b7d5b4f 100644
--- a/src/site/markdown/usage.md
+++ b/src/site/markdown/usage.md
@@ -28,7 +28,7 @@ under the License.
# Usage
-You can put additional content (e.g. documentation, resources, etc.) in your
site. See [Creating Content](./examples/creating-content.html) for more
information on this. If you want to change the menus, breadcrumbs, links or
logos on your pages you need to add and configure a [site
descriptor](./examples/sitedescriptor.html). If you like, you also can let
Maven generate some [reports](./examples/configuring-reports.html) for you,
based on the contents of your POM.
+You can put additional content (e.g. documentation, resources, etc.) in your
site. See [Creating a
site](https://maven.apache.org/guides/mini/guide-site.html) for more
information on this. If you want to change the menus, breadcrumbs, links or
logos on your pages you need to add and configure a [site
descriptor](./examples/sitedescriptor.html). If you like, you also can let
Maven generate some [reports](./examples/configuring-reports.html) for you,
based on the contents of your POM.
<!-- MACRO{toc|section=1|fromDepth=2|toDepth=3} -->
diff --git a/src/site/site.xml b/src/site/site.xml
index 4366ffbb..8012c3c9 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -21,7 +21,6 @@ under the License.
<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"/>
@@ -36,24 +35,24 @@ under the License.
</menu>
<menu name="Examples">
- <item name="Creating Content" href="/examples/creating-content.html"/>
- <item name="Filtering Content" href="/examples/filtering-content.html"/>
+ <item name="Creating Content"
href="https://maven.apache.org/guides/mini/guide-site.html#Creating_Content"/>
+ <item name="Filtering Content"
href="https://maven.apache.org/guides/mini/guide-site.html#Filtering_with_Maven_Resources_Plugin"/>
<item name="Configuring the Site Descriptor"
href="/examples/sitedescriptor.html"/>
- <item name="Building a multi-module site"
href="/examples/multimodule.html"/>
+ <item name="Building a multi-module site"
href="https://maven.apache.org/guides/mini/guide-multimodule-site.html"/>
<item name="Configuring Site Run" href="/examples/siterun.html"/>
<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"/>
+ <item name="Mermaid Diagrams"
href="https://maven.apache.org/doxia/mermaid-diagrams.html"/>
</menu>
<menu name="Reports">
<item name="Configuring Reports"
href="/examples/configuring-reports.html"/>
- <item name="Reports Internationalization" href="i18n.html"/>
+ <item name="Reports Internationalization"
href="https://maven.apache.org/plugins/localization.html"/>
</menu>
<menu name="Site Template">
- <item name="Creating Skins" href="/examples/creatingskins.html"/>
+ <item name="Creating Skins"
href="https://maven.apache.org/skins/#Creating_a_skin"/>
</menu>
<menu name="Deploying">