Usage
To use this Maven skin, include it in your site.xml site descriptor file:
<project>
...
<skin>
<groupId>pl.matsuo.maven.skins</groupId>
<artifactId>msb3-maven-skin</artifactId>
<version>0.1.1</version>
</skin>
...
</project>
The skin is provided on the works on my computer basis at the moment. I am using the newest versions of maven-site-plugin and other components and at the moment do not have any feedback on using the skin with Maven 2 site or other configurations.
POM dependencies
Add msb3-velocity-tools dependency to maven-site-plugin in the POM file:
<build>
<plugins>
...
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<version>3.3</version>
<dependencies>
...
<dependency>
<groupId>pl.matsuo.maven.skins</groupId>
<artifactId>msb3-velocity-tools</artifactId>
<version>0.1.1</version>
</dependency>
<!-- Msb3 skin requires Velocity >= 1.7 -->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity</artifactId>
<version>1.7</version>
</dependency>
...
</dependencies>
...
</plugin>
...
</plugins>
</build>
Msb3 Velocity tools (msb3-velocity-tools) are required by the Msb3 skin to read skin configuration and provides other functionality. The library must be available when generating Maven site.
Note that Velocity 1.7 is also required by the template.
Configuration
The skin is configurable using the <custom> element in your site.xml file. The available options are described in the documentation. A sample configuration file is below:
<project>
...
<custom>
<msb3Skin>
<theme>bootswatch-spacelab</theme>
<highlightJs>true</highlightJs>
<brand>
<name>My Project</name>
<href>http://github.com/tunguski/msb3-maven-skin</href>
</brand>
<slogan>Super interesting project doing good things.</slogan>
<titleTemplate>%2$s | %1$s</titleTemplate>
<toc>top</toc>
<topNav>Download|reports</topNav>
<bottomNav>
<column>Main|Download</column>
<column>Documentation</column>
<column>reports|modules</column>
</bottomNav>
<bottomDescription>
This is a very good project doing interesting and valuable things.
</bottomDescription>
<pages>
<index project="project-id">
<shortTitle>Welcome</shortTitle>
<breadcrumbs>false</breadcrumbs>
<toc>false</toc>
<sections>
<carousel />
<body />
<sidebar />
<thumbs>2</thumbs>
<columns>3</columns>
</sections>
</index>
<developer-info>
<toc>sidebar</toc>
</developer-info>
</pages>
</msb3Skin>
</custom>
...
</project>
Learn by example
This website itself is generated using Msb3 Maven skin and is written in Markdown. The source code is available on GitHub.
Look for the site configuration and web page sources in /src/site of each module; and for plug-in configuration in respective POM files.