Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/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.
https://github.com/devacfr/reflow-maven-skin

bootstrap4 maven shortcode site skin snippet themes webcomponent

Last synced: about 1 month ago
JSON representation

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.

Host: GitHub
URL: https://github.com/devacfr/reflow-maven-skin
Owner: devacfr
License: apache-2.0
Fork: true (andriusvelykis/reflow-maven-skin)
Created: 2014-09-18T13:52:11.000Z (about 10 years ago)
Default Branch: develop
Last Pushed: 2024-04-16T06:19:54.000Z (7 months ago)
Last Synced: 2024-09-19T11:13:50.157Z (about 2 months ago)
Topics: bootstrap4, maven, shortcode, site, skin, snippet, themes, webcomponent
Language: Java
Homepage: http://devacfr.github.io/reflow-maven-skin/
Size: 44.5 MB
Stars: 8
Watchers: 6
Forks: 3
Open Issues: 14
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

[![Apache License, Version 2.0](https://img.shields.io/github/license/apache/maven.svg?label=License&style=for-the-badge&logo=apache)][license]
[![Maven Central](https://img.shields.io/maven-central/v/io.github.devacfr.maven.skins/reflow-maven-skin.svg?style=for-the-badge&logo=apache-maven)][maven-repo]

[![Dev Plan](https://github.com/devacfr/reflow-maven-skin/workflows/Development%20Plan/badge.svg?branch=develop)](https://github.com/devacfr/reflow-maven-skin/actions?query=workflow%3A%22Development+Plan%22)
[![Release Plan](https://github.com/devacfr/reflow-maven-skin/workflows/Release%20Plan/badge.svg?branch=master)](https://github.com/devacfr/reflow-maven-skin/actions?query=workflow%3A%22Release+Plan%22)

[![Gitter](https://badges.gitter.im/Join%20In.svg)][gitter]
[![Stack Exchange monthly questions](https://img.shields.io/stackexchange/stackoverflow/qm/reflow-maven-plugin?style=for-the-badge&logo=stackexchange)](http://stackoverflow.com/questions/tagged/reflow-maven-skin)

[license]: https://www.apache.org/licenses/LICENSE-2.0
[maven-repo]: http://mvnrepository.com/artifact/io.github.devacfr.maven.skins/reflow-maven-skin
[gitter]: https://gitter.im/reflow-maven-skin/public

# Reflow Maven skin

Reflow is an Apache Maven site skin built on [Bootstrap 4][bootstrap]. 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][reflow]!

[reflow]: http://devacfr.github.io/reflow-maven-skin/
[migration]: http://devacfr.github.io/reflow-maven-skin/doc/reflow-documentation.html#migration.html
[bootstrap]: http://getbootstrap.com

## 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/necolas/issue-guidelines).

[http://github.com/devacfr/reflow-maven-skin/issues](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](https://github.com/takari/takari-maven-plugin) or with Maven from Docker. The last one is the easiest solution with you don't want install a jdk8.

**Maven local**

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

**Maven Wrapper**

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

**Maven from Docker**

```bash
$ ./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

jdk

1.8

/usr/lib/jvm/java-8-openjdk-amd64

jdk

9

/usr/lib/jvm/jdk-9.0.4

```

### Site Generation

Use following command to generate site.

```bash
$ ./ci/site-generate.sh
```

### Site Run

Use following command to generate and run site.

```bash
$ ./ci/site-run.sh
```

### Site Deployment

Use following command to generate and deploy site.

```bash
$ ./ci/site-deploy.sh
```

## Author

**Andrius Velykis**

- [http://andrius.velykis.lt](http://andrius.velykis.lt)
- [http://github.com/andriusvelykis](http://github.com/andriusvelykis)

**Christophe Friederich**

- [http://devacfr.github.io/](http://devacfr.github.io/)

## Copyright and license

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.

[release-management]: http://github.com/devacfr/doc/development-documentation.html#dev-release-management