Decorative site banner
Project icon

com.io7m.minisite

  • About
  • Releases
  • Manual
  • Sources
  • License
  • Issues
Maven Central Version Maven Snapshot Code Coverage

minisite

The minisite package package implements a trivial replacement for the Maven site plugin.

Features

  • Single-page, static, XHTML 1.0 Strict, Javascript-free sites.
  • Optional com.io7m.changelog integration.
  • ISC license.

Usage

The plugin is designed to produce an extremely simple, static, single-page, XHTML 1.0 Strict site with no Javascript. The plugin assumes the existence of a 64x64 PNG file at src/site/resources/icon.png.

Add the following execution to the root module in your project:

<build> <plugins> <!-- Disable the existing maven-site-plugin --> <plugin> <artifactId>maven-site-plugin</artifactId> <version>...</version> <executions> <execution> <id>default-site</id> <phase>none</phase> <goals> <goal>site</goal> </goals> </execution> </executions> </plugin> <plugin> <groupId>com.io7m.minisite</groupId> <artifactId>com.io7m.minisite.maven_plugin</artifactId> <version>...</version> <executions> <execution> <id>minisite</id> <phase>site</phase> <goals> <goal>generateSite</goal> </goals> <configuration> <headerFile>src/site/resources/header.xml</headerFile> <overviewFile>src/site/resources/overview.xml</overviewFile> <featuresFile>src/site/resources/features.xml</featuresFile> <documentationFile>src/site/resources/documentation.xml</documentationFile> <changelogFile>README-CHANGES.xml</changelogFile> <changelogFeedEmail>youremail@example.com</changelogFeedEmail> <outputDirectory>${project.build.directory}/minisite</outputDirectory> <resourcesDirectory>${project.base.directory}/src/site/resources</resourcesDirectory> <cssGenerateDefault>true</cssGenerateDefault> <cssStyles> <cssStyle>minisite.css</cssStyle> <cssStyle>example0.css</cssStyle> <cssStyle>example1.css</cssStyle> </cssStyles> </configuration> </execution> </executions> <inherited>false</inherited> </plugin> </plugins> </build>

By default, the maven-site-plugin is bound to the Maven site lifecycle phase, so it's generally preferred to disable the plugin by explicitly binding it to the none phase. The minisite plugin is intended for use with multi-module builds and is designed to run at most once for the parent module, in contrast to the once-per-module execution model of the maven-site-plugin. It's therefore recommended to set inherited to false as shown so that the plugin won't execute for any child modules.

The overviewFile parameter specifies an XHTML file that will be inserted into the overview section of the generated site.

The documentationFile parameter specifies an XHTML file that will be inserted into the documentation section of the generated site.

The featuresFile parameter specifies an XHTML file that will be inserted into the features section of the generated site.

The headerFile parameter specifies an XHTML file that will be inserted into the header section of the generated site (above the logo and title).

The changelogFile parameter specifies an XML changelog in changelog format that will be converted into XHTML for the generated site. If no file is specified, no changes section will be generated.

The changelogFeedEmail parameter the email address that will be used when generating an RSS feed for the changelog.

The outputDirectory parameter specifies the directory to which site files will be generated, and resources copied. This parameter is optional and defaults to ${project.build.directory}/minisite.

The resourcesDirectory parameter specifies the directory from which site resources will be copied copied. This parameter is optional and defaults to ${project.base.directory}/src/site/resources.

The cssGenerateDefault parameter specifies that the plugin should copy a default CSS style to the output directory. The parameter is optional and defaults to true.

The cssStyles parameter specifies a list of CSS styles that should be imported by the generated site.

Releases & Development Snapshots

Releases

You can subscribe to the atom feed to be notified of project releases.

The most recently released version of the package is 5.1.0.

5.1.0 Release (2024-12-07Z)

  • Update io.takari.maven.plugins:takari-lifecycle-plugin:2.1.4 → 2.1.5.
  • Update org.apache.maven.plugins:maven-plugin-plugin:3.12.0 → 3.13.0.
  • Update com.io7m.jlexing:com.io7m.jlexing.core:3.1.0 → 3.2.0.
  • Update io7m.maven-api.version:3.9.6 → 3.9.7.
  • Update org.apache.maven.plugins:maven-plugin-plugin:3.13.0 → 3.13.1.
  • Update io7m.maven-api.version:3.9.7 → 3.9.8.
  • Update io.takari.maven.plugins:takari-lifecycle-plugin:2.1.5 → 2.1.6.
  • Update io.takari.maven.plugins:takari-plugin-testing:3.0.2 → 3.0.3.
  • Update org.slf4j:slf4j-api:2.0.13 → 2.0.14.
  • Update org.slf4j:slf4j-api:2.0.14 → 2.0.15.
  • Update org.slf4j:slf4j-api:2.0.15 → 2.0.16.
  • Update ch.qos.logback:logback-classic:1.5.6 → 1.5.7.
  • Update io7m.maven-api.version:3.9.8 → 3.9.9.
  • Update org.apache.maven.plugins:maven-plugin-plugin:3.13.1 → 3.14.0.
  • Update io.takari.maven.plugins:takari-lifecycle-plugin:2.1.6 → 2.1.7.
  • Update io.takari.maven.plugins:takari-plugin-testing:3.0.3 → 3.0.4.
  • Update org.apache.maven.plugins:maven-plugin-plugin:3.14.0 → 3.15.0.
  • Update ch.qos.logback:logback-classic:1.5.7 → 1.5.8.
  • Update io.takari.maven.plugins:takari-lifecycle-plugin:2.1.7 → 2.1.8.
  • Update io.takari.maven.plugins:takari-plugin-testing:3.0.4 → 3.0.5.
  • Update io.takari.maven.plugins:takari-lifecycle-plugin:2.1.8 → 2.2.0.
  • Update ch.qos.logback:logback-classic:1.5.8 → 1.5.9.
  • Update ch.qos.logback:logback-classic:1.5.9 → 1.5.10.
  • Update ch.qos.logback:logback-classic:1.5.10 → 1.5.11.
  • Update org.apache.maven.plugins:maven-plugin-plugin:3.15.0 → 3.15.1.
  • Update ch.qos.logback:logback-classic:1.5.11 → 1.5.12.
  • Use changelog 5.0.0-beta0002.

The compiled artifacts for the release (and all previous releases) are available on Maven Central.

Maven Modules

<dependency> <group>com.io7m.minisite</group> <artifactId>com.io7m.minisite.core</artifactId> <version>5.1.0</version> </dependency><dependency> <group>com.io7m.minisite</group> <artifactId>com.io7m.minisite.tests</artifactId> <version>5.1.0</version> </dependency><dependency> <group>com.io7m.minisite</group> <artifactId>com.io7m.minisite.maven_plugin</artifactId> <version>5.1.0</version> </dependency>

Previous Releases

The changelogs for the most recent previous releases are as follows:

5.0.0 Release (2024-04-20Z)

  • Update com.io7m.primogenitor:com.io7m.primogenitor.support:7.5.0 → 8.2.0
  • Update ch.qos.logback:logback-classic:1.4.5 → 1.5.6
  • Update org.slf4j:slf4j-api:2.0.6 → 2.0.13
  • Update org.apache.maven.plugin-tools:maven-plugin-annotations:3.7.0 → 3.12.0
  • Update io.takari.maven.plugins:takari-plugin-testing:3.0.1 → 3.0.2
  • Update org.immutables:value:2.9.3 → 2.10.1
  • Update com.io7m.minisite:com.io7m.minisite.maven_plugin:5.0.0-beta0001 → 5.0.0-SNAPSHOT
  • Update org.apache.maven:maven-artifact:3.8.6 → 3.9.6
  • Update org.apache.maven:maven-compat:3.8.6 → 3.9.6
  • Update org.apache.maven:maven-core:3.8.6 → 3.9.6
  • Update org.apache.maven:maven-model:3.8.6 → 3.9.6
  • Update org.apache.maven:maven-plugin-api:3.8.6 → 3.9.6
  • Update org.apache.maven:maven-settings:3.8.6 → 3.9.6
  • Require JDK 21 (Backwards incompatible)

4.0.0 Release (2021-05-02Z)

  • Remove xom as a dependency
  • Modularize the API

3.0.0 Release (2020-12-11Z)

  • Require JDK 11 (Backwards incompatible)
  • Use changelog 4.0.0

2.0.1 Release (2018-09-13Z)

  • Stop reindenting XHTML output as this tends to break pages (Tickets: 4)

Development Snapshots

At the time of writing, the current unstable development version of the package is 5.2.0-SNAPSHOT.

Development snapshots may be available in the Central Portal Snapshots repository. Snapshots are published to this repository every time the project is built by the project's continuous integration system, but snapshots do expire after around ninety days and so may or may not be available depending on when a build of the package was last triggered.

Manual

This project does not have any user manuals or other documentation beyond what might be present on the page above.

Sources

This project uses Git to manage source code.

Repository: https://www.github.com/io7m-com/minisite

$ git clone --recursive https://www.github.com/io7m-com/minisite

Issues

This project uses GitHub Issues to track issues.

License

Copyright © 2023 Mark Raynsford <code@io7m.com> https://www.io7m.com Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Last Updated 2025-08-09T14:58:04Z