Available Skins
The following table lists skins that are available for you to use in your Maven generated site.
Note: You always have to define a skin, if you are using a site descriptor. There is no default skin applied automatically.
Maintained By The Maven Project
| Skin | Version | Site Plugin Version | Description | Source Repository | Issue Tracking |
|---|---|---|---|---|---|
Maven Fluido Skin |
2.1.0 | [3.21.0,) | Skin based on Bootstrap CSS. | Git / GitHub | GitHub Issues |
Maven Fluido Skin |
1.12.0 | [3.10.0,3.20.0) | Skin based on Bootstrap CSS. | Git / GitHub | GitHub Issues |
Retired
| Skin | Version | Site Plugin Version | Retired Date | Description |
|---|---|---|---|---|
Maven Default Skin (unofficially) |
1.3 | [3.5,3.20.0) | 2019-07-28 | Formerly, this skin got applied, if no skin was configured in the site descriptor. |
Maven Application Skin |
1.0 | (,3.4] | 2015-12-28 | A skin used by applications like Continuum. |
Maven Classic Skin |
1.1 | (,3.4] | 2015-12-28 | This skin resembles the look of a site generated by Maven 1. |
Maven Stylus Skin |
1.5 | (,3.4] | 2015-12-28 | The skin used for the website of Maven itself. |
Outside The Maven Land
| Skin | Maintainer | Description |
|---|---|---|
Reflow Maven Skin |
Olivier Lamy | Responsive Apache Maven skin to reflow the standard Maven site with a modern feel. |
Reflow 2 Maven Skin |
Friederich Christophe | Responsive 2 Apache Maven skin to reflow the standard Maven site with a modern feel. |
Docs Maven Skin |
Bernardo Martínez Garrido | A minimalist and responsive Bootstrap-based HTML5 skin for Maven Site, which will help to use it as a documentation site. |
Bootstrap Site Skin |
Stephen Crocker | Responsive Maven Bootstrap Skin which has toggleable elements implemented based on the boostrap reference layouts. |
Sentry Maven Skin |
Sentry Software | Responsive skin, Bootstrap-based, with local search, light/dark colors switch, WEBP conversion, etc. |
Instructions
To apply one of these skins to your project's site, 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, you would include this in your site.xml file:
<site>
...
<skin>
<groupId>org.apache.maven.skins</groupId>
<artifactId>maven-fluido-skin</artifactId>
<version>2.1.0</version>
</skin>
...
</site>
Creating a skin
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 tweak the output templates that Maven uses to generate the site documentation.
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.vmfor an alternate HTML rendering of the site - Since Maven Site Plugin 3.5, an optional skin descriptor in
/META-INF/maven/skin.xmlcontaining metadata about the skin
The maven-archetype-site-skin archetype creates a complete new skin project, including its dedicated /META-INF/maven/site.vm.
A skin is built like any other JAR, with a packaging of jar. No additional plugins are needed. Put resources in the normal src/main/resources directory. Once the JAR is built and deployed, projects can use it.
To construct your own CSS, copy the file maven-theme.css from Maven Fluido Skin and modify it to suit your needs.
The format of the Velocity template is out of scope for this page. For more information about how to write Velocity templates see the Velocity User Guide and the Velocity Template Language Reference Guide. Velocity 2.3 is used since Maven Site Plugin 4.0.0-M2; version 1.7 was used previously.