Usage

Before official release you need to build this plugin locally.

To use this Maven skin, include it in your site.xml site descriptor file:

<project>
  ...
  <skin>
    <groupId>pl.matsuo.maven.skins</groupId>
    <artifactId>msb4-maven-skin</artifactId>
    <version>0.1.0-SNAPSHOT</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 msb4-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>4.0</version>
      <dependencies>
        ...
        <dependency>
          <groupId>pl.matsuo.maven.skins</groupId>
          <artifactId>msb4-velocity-tools</artifactId>
          <version>0.1.0-SNAPSHOT</version>
        </dependency>
        <!-- Msb4 skin requires Velocity >= 1.7  -->
        <dependency>
          <groupId>org.apache.velocity</groupId>
          <artifactId>velocity</artifactId>
          <version>1.7</version>
        </dependency>
        ...
      </dependencies>
      ...
    </plugin>
    ...
  </plugins>
</build>

Msb4 Velocity tools (msb4-velocity-tools) are required by the Msb4 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.

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>
    <msb4Skin>
      <theme>bootswatch-spacelab</theme>
      <highlightJs>true</highlightJs>
      <brand>
        <name>My Project</name>
        <href>http://github.com/tunguski/msb4-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>
    </msb4Skin>
  </custom>
  ...
</project>

Learn by example

This website itself is generated using Msb4 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.

Usage

POM dependencies

Configuration

Learn by example