devacfr / reflow-maven-skin

Reflow is an Apache Maven site skin built on Bootstrap. It allows various structural and stylistic customizations to create a modern-looking Maven-generated website.
http://devacfr.github.io/reflow-maven-skin/
Apache License 2.0
8 stars 3 forks source link
bootstrap4 maven shortcode site skin snippet themes webcomponent

Apache License, Version 2.0 Maven Central

Dev Plan Release Plan

Gitter Stack Exchange monthly questions

Reflow Maven skin

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

To get started and see how the skin looks by default, check out reflow-maven-skin!

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/devacfr/reflow-maven-skin/issues

Contributing

Contributions via GitHub pull requests are gladly accepted from their original author. Along with any pull requests, please state that the contribution is your original work and that you license the work to the project under the project's open source license. Whether or not you state this explicitly, by submitting any copyrighted material via pull request, email, or other means you agree to license the material under the project's open source license and warrant that you have the legal authority to do so.

Compiling

You can compile Reflow project with your local Maven, with Maven Wrapper or with Maven from Docker. The last one is the easiest solution with you don't want install a jdk8.

Maven local

$ mvn clean install -P skipTests -Dtoolchains.disabled=true

Maven Wrapper

$ ./mvnw clean install -Dtoolchains.disabled=true

Maven from Docker

$ ./mvnd clean install

The profile skipTests allows to skip all tests execution.

Use the parameter toolchains.disabled to disable maven toolchains plugin whether you are not configure your ${HOME}/.m2/toolchains.xml file. Here is a example of ${HOME}/.m2/toolchains.xml

<?xml version="1.0" encoding="UTF8"?>
<toolchains>
  <!-- JDK toolchains -->
  <toolchain>
    <type>jdk</type>
    <provides>
      <version>1.8</version>
    </provides>
    <configuration>
      <jdkHome>/usr/lib/jvm/java-8-openjdk-amd64</jdkHome>
    </configuration>
  </toolchain>
  <toolchain>
    <type>jdk</type>
    <provides>
      <version>9</version>
    </provides>
    <configuration>
      <jdkHome>/usr/lib/jvm/jdk-9.0.4</jdkHome>
    </configuration>
  </toolchain>
</toolchains>

Site Generation

Use following command to generate site.

$ ./ci/site-generate.sh

Site Run

Use following command to generate and run site.

$ ./ci/site-run.sh

Site Deployment

Use following command to generate and deploy site.

$ ./ci/site-deploy.sh

Author

Andrius Velykis

Christophe Friederich

Copyright and license

Copyright 2012-2019 Christophe Friederich

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.