Msb4 Maven Skin

Msb4 Maven Skin

Apache Maven skin built on Bootstrap 4.0

Other configuration

This page lists various other configuration options for Msb4 Maven skin.

JavaScript goodies

Code highlight

Code highlighting can be provided for source code sections in pages using highlight.js. It detects the language automatically and provides code highlighting functionality. To enable it, use <highlightJs> flag:

<highlightJs>true|false</highlightJs>
  • true - Source code is highlighted (syntax colouring) - requires JavaScript
  • false (default) - Source code is displayed in fixed font without syntax colouring

Code highlighting theme can be changed to match your website theme. Available themes are listed in highlight.js website. The theme can be selected using <highlightJsTheme> element:

<highlightJsTheme>default|*</highlightJsTheme>
  • default (default) - Default code highlighting theme is used
  • theme name - Entered theme is used

Image previews (lightbox)

Msb4 skin enables CSS pop-ups for image links on the website using Lightbox 2. See one in action by opening this link to an image. The previews are enabled by default but can be disabled using <imgLightbox> flag:

<imgLightbox>true|false</imgLightbox>
  • true (default) - when image link is opened in the website, opens a lightweight CSS pop-up with the image over the page
  • false - disable lightbox, image link will open the image itself

Smooth scroll

Msb4 skin enables smooth scrolling for in-page navigation (e.g. for table of contents links). Smooth scrolling can be disabled using <smoothScroll> flag:

<smoothScroll>true|false</smoothScroll>
  • true (default) - smooth scrolling for in-page navigation (requires JavaScript)
  • false - default in-page jumps

Bootstrap

The generated Maven site code is updated by default, e.g. update CSS of generated tables, use Bootstrap icons and other goodies. The flags to disable these updates are described below.

Bootstrap CSS

Bootstrap provides nice CSS effects for certain elements, such as tables, etc. Msb4 skin rewrites some Maven site generated elements to add Bootstrap classes and configurations. This can be disabled using bootstrapCSS flag:

<bootstrapCSS>true|false</bootstrapCSS>
  • true (default) - adds Bootstrap CSS classes to tables; fixes table headings
  • false - keep original table HTML

Bootstrap icons

To match Bootstrap themes, Msb4 skin replaces some icons used by Maven site with corresponding Bootstrap icons, e.g. in change log page and others:

This can be disabled using bootstrapIcons flag:

<bootstrapIcons>true|false</bootstrapIcons>
  • true (default) - replaces images (add, remove, warning, info etc) with corresponding Bootstrap icons
  • false - keep original images

HTML5-style anchors

Anchors (links to page elements) in HTML5 are defined using id attribute on any element. Previously anchors used the <a name="..."> element. Msb4 transforms these <a> anchors to HTML5 equivalents where applicable by default. Disable with html5Anchor flag.

<html5Anchor>true|false</html5Anchor>
  • true (default) - HTML4-style anchors <a name="..."> are replaced with id attributes where applicable
  • false - keep the original anchors

Bootstrap themes provide an alternative colour for top navigation bar. To use the inverse navigation bar colour, add the <navbarInverse> flag:

<navbarInverse>true|false</navbarInverse>
  • true - Inverted navigation bar colour is used
  • false (default) - Default Bootstrap theme colour is used for navigation bar

Mark page header

By default, the first <h1> or <h2> heading in the page body is marked as page header. It allows Bootstrap CSS to give it an emphasised presentation. To disable page header being marked, use the <markPageHeader> flag:

<markPageHeader>true|false</markPageHeader>
  • true (default) - The first heading (<h1> or else <h2>) in page is marked
  • false - Page content is unchanged

Protocol-relative URLs

By default, a number of core resources are loaded from the cloud. Bootstrap, JQuery, Bootstrap themes and other components are not local to the website, but loaded from corresponding Content Delivery Networks. This reduces the load on the server and improves latency for users, who may have these resources already cached.

To support both http:// and https:// websites, these resources can be referenced using protocol-relative URLs, starting with //. However, this is not supported when building the website locally, for file:// URLs.

For this reason, the protocol-relative URLs are disabled by default. Enable them using <protocolRelativeURLs> flag:

<protocolRelativeURLs>true|false</protocolRelativeURLs>
  • true - Bootstrap CSS, JS and other resources are referenced using protocol-relative URLs: //
  • false (default) - Resources are referenced using http:// protocol

Skin attribution

The Msb4 skin is released under the Apache license and thus can be used freely. By default, a link to the skin website and the author homepage is added at the bottom of the skin: Msb4 Maven skin by Marek Romanowski. I would appreciate if you kept the link - it will help with the popularity of the skin. If you want, it can be disabled using <skinAttribution> flag:

<skinAttribution>true|false</skinAttribution>
  • true (default) - Include links to Msb4 skin homepage and author’s website
  • false - Remove skin attribution text and links

Back to top

Copyright ©2015-2016 Marek Romanowski. All Rights Reserved.

Version: 0.1.0-SNAPSHOT. Last Published: 2016-01-03.

Msb4 Maven skin by Marek Romanowski.