Andrius Velykis Andrius Velykis

Modernise Maven site with new Reflow Maven skin

I have decided to dust off and finally release some projects that occupied some of my time in the past but then got forgotten or postponed somehow… The first of these is a new skin for Apache Maven site: Reflow Maven skin.

The new skin allows generating a Maven site that builds on Bootstrap and offers responsive design, modern web components, JavaScript goodies and wide customisation options. See it in action and read the documentation at Reflow skin website:

http://andriusvelykis.github.io/reflow-maven-skin/

An obligatory screenshot follows. Read on for a bit more details about the skin.

Reflow Maven skin in action
Reflow Maven skin in action

What is it?

Apache Maven is a build automation and project management tool primarily for Java-based software projects. I use it for all my code projects! (I think) As part of its vast functionality range, Maven allows writing and configuring a website for the project, which is generated automatically and links with the projects and code quite nicely. The appearance of the generated site is configured using skins: Maven plug-ins that define site template, CSS and other resources. The new Reflow Maven skin adds to the existing selection of different skins.

Reflow skin started as a new skin for the (still) upcoming Community Z Tools 2.0 release we have been preparing. Soon CZT website should look a bit more modern..!

Inspired by Maven Fluido skin, I wanted to change some things for CZT and thus started a new skin. Soon I realised it was becoming quite general to be used by other Maven projects as well. After having taken care of some rough edges and written some documentation, here I am with the 1.0.0 release of the skin.

Features

Reflow skin aims to modernise the Maven site by providing various components, layouts, themes and other customisation options. Some of them are listed below:

  • Built on Bootstrap
    Responsive design, modern CSS and JavaScript components;
  • Themes
    Custom Bootstrap themes or select an excellent free theme from Bootswatch;
  • Layouts
    Different layouts for page sections, such as carousel, thumbnails, multi-column text and more;
  • New or enhanced** components** and goodies
    Table of contents, filtered menus, code highlighting, image previews and more;
  • Flexible customisation
    Global or per-page configuration of every option;
  • Custom Velocity tools
    More power to your own Maven skin templates with tools for skin configuration access and HTML rewriting;
  • … and more—check out the website for all details.

Use it

Setup a Maven site for your Maven project and add the reflow-maven-skin to the site.xml site descriptor file. Note that the skin requires accompanying reflow-velocity-tools as a dependency. All usage details and configuration examples are available in Reflow skin website.

Reflow skin is open source and licensed under Apache license. The skin can be used freely for your Maven projects. Contribute by reporting issues, suggesting new features, or forking the Git repository on GitHub and adding some good code!

Visit Reflow Maven skin website.

Topics: Coding - CZT - Maven - reflow-maven-skin - releases # Top


comments powered by Disqus