andriusvelykis / 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://andriusvelykis.github.io/reflow-maven-skin/
Apache License 2.0
132 stars 54 forks source link

Custom/local resources #24

Closed andriusvelykis closed 10 years ago

andriusvelykis commented 10 years ago

Reflow skin currently cannot be used in an offline/intranet setting, since jQuery and highlight.js are loaded from CDN.

Provide a <localResources> flag for CDN-less jQuery library, since it is a core requirement. Furthermore, the flag will force the use of local Bootstrap CSS and JS files as well.

For non-core resources such as highlight.js, <body><head> or <endContent> (see #23) elements can be used to replace the existing versions. Also see discussions in #18 and #17.

andriusvelykis commented 10 years ago

Added support in 38c3cda2588e1045378d852061f2309ba285a8f9.

Note that when using <localResources>, you need to provide the necessary local versions of Bootstrap and jQuery files. Reflow skin does not package the default files at the moment, mainly because overriding packaged files is not possible at the moment (see issue MSITE-702). Therefore it is easier to get appropriate Bootstrap files directly from the customiser or Bootswatch and use them with the Reflow skin. Furthermore, such approach allows you to customise the Bootstrap and jQuery versions used. Use at your own risk, however, as major version changes are likely to break the website!

When using <localResources>, the following files need to be available in the corresponding directories within your project's src/site/resources folder:

Added all this info to the documentation as well.