JarCasting
JarCasting JarCasting

Msb3 Maven Skin Parent

Msb3 Maven skin and supporting libraries parent

License

License
Categories

Categories

Maven Build Tools
GroupId

GroupId

pl.matsuo.maven.skins
ArtifactId

ArtifactId

msb3-parent
Last Version

Last Version

0.1.1
Release Date

Release Date
Type

Type

pom
Description

Description

Msb3 Maven Skin Parent
Msb3 Maven skin and supporting libraries parent
Project URL

Project URL

https://tunguski.github.io/msb3-maven-skin
Project Organization

Project Organization

Marek Romanowski
Source Code Management

Source Code Management

https://github.com/tunguski/msb3-maven-skin/tree/master

Download msb3-parent

Filename Size
msb3-parent-0.1.1.pom 11 KB
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/pl.matsuo.maven.skins/msb3-parent/ -->
<dependency>
    <groupId>pl.matsuo.maven.skins</groupId>
    <artifactId>msb3-parent</artifactId>
    <version>0.1.1</version>
    <type>pom</type>
</dependency>
// https://jarcasting.com/artifacts/pl.matsuo.maven.skins/msb3-parent/
implementation 'pl.matsuo.maven.skins:msb3-parent:0.1.1'
// https://jarcasting.com/artifacts/pl.matsuo.maven.skins/msb3-parent/
implementation ("pl.matsuo.maven.skins:msb3-parent:0.1.1")
'pl.matsuo.maven.skins:msb3-parent:pom:0.1.1'
<dependency org="pl.matsuo.maven.skins" name="msb3-parent" rev="0.1.1">
  <artifact name="msb3-parent" type="pom" />
</dependency>
@Grapes(
@Grab(group='pl.matsuo.maven.skins', module='msb3-parent', version='0.1.1')
)
libraryDependencies += "pl.matsuo.maven.skins" % "msb3-parent" % "0.1.1"
[pl.matsuo.maven.skins/msb3-parent "0.1.1"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

  • msb3-velocity-tools
  • msb3-maven-skin

Msb3 Maven skin

Msb3 is an Apache Maven site skin built on Bootstrap 3.3. It allows various structural and stylistic customizations to create a modern-looking Maven-generated website.

To get started and see how the skin looks by default, check out http://tunguski.github.io/msb3-maven-skin!

Usage

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

<project>
  ...
  <skin>
    <groupId>pl.matsuo.maven.skins</groupId>
    <artifactId>msb3-maven-skin</artifactId>
    <version>0.1.2-SNAPSHOT</version>
  </skin>
  ...
</project>

The skin requires accompanying Msb3 Velocity tools (msb3-velocity-tools) to be available when generating Maven site. Add them as a dependency to maven-site-plugin in your 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.2-SNAPSHOT</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>

Note that Apache Velocity 1.7 is also required by the template.

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.

Configuration

The skin is configurable using the <custom><msb3Skin> element in your site.xml file. Refer to documentation for all configuration options.

A sample configuration file is given below:

<project>
  ...
  <custom>
    <msb3Skin>
      <theme>bootswatch-spacelab</theme>
      <brand>
        <name>My Project</name>
        <href>http://tunguski.github.io/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>

Bug tracker

Have a bug or a feature request? Please create an issue here on GitHub that conforms with necolas's guidelines.

http://github.com/tunguski/msb3-maven-skin/issues

Contributing

Fork the repository and submit pull requests.

Author

Marek Romanowski

Copyright and license

Copyright 2015 Marek Romanowski

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or 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.

Versions

Version
0.1.1
0.1.0