Skip to content

Minimalist HTML5 and Bootstrap based Maven Skin for using Maven Site as a documentation site.

License

Notifications You must be signed in to change notification settings

Bernardo-MG/docs-maven-skin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

53 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Docs Maven Skin

A minimalist Bootstrap-based HTML5 skin for Maven Site, which will help to use it as a documentation site.

While it can be used by itself, just remember to check the documentation to find out how to set it up. New projects may as well make use of the Library Maven Archetype which, among other features, makes use of this skin.

The skin has been adapted from the static template Docs Bootstrap Template, which will be the visual reference to be followed by this project.

Maven Central Bintray

Release docs Development docs

Feature

  • Minimalist and reactive look
  • HTML5
  • Bootstrap
  • Font Awesome icons

Demo

To check how the skin looks take a look at the documentation, linked below this section, which is a Maven Site making use of the skin.

Documentation

Documentation is always generated for the latest release, kept in the 'master' branch:

Documentation is also generated from the latest snapshot, taken from the 'develop' branch:

The documentation site sources come along the source code (as it is a Maven site), so it is always possible to generate them using the following Maven command:

$ mvn verify site

The verify phase is required, as otherwise some of the reports won't be created.

Usage

The application is coded in Velocity Template Language, using Maven to manage the project.

Prerequisites

This project requires a Maven-based project, with Maven Site enabled.

All other dependencies are handled through Maven, and noted in the included POM file.

Installing

The recommended way to install the project is by setting up your preferred dependencies manager. To get the configuration information for this check the Bintray repository, or the Maven Central Repository.

If for some reason manual installation is necessary, just use the following Maven command:

$ mvn install

Collaborate

Any kind of help with the project will be well received, and there are two main ways to give such help:

  • Reporting errors and asking for extensions through the issues management
  • or forking the repository and extending the project

Issues management

Issues are managed at the GitHub project issues tracker, where any Github user may report bugs or ask for new features.

Getting the code

If you wish to fork or modify the code, visit the GitHub project page, where the latest versions are always kept. Check the 'master' branch for the latest release, and the 'develop' for the current, and stable, development version.

License

The project has been released under the MIT License.