Package com.io7m.minisite.core

Interface MinConfigurationType

All Known Implementing Classes:
MinConfiguration
@Immutable
public interface MinConfigurationType
Configurations for sites.

  • Method Details

    • projectName

      @Parameter java.lang.String projectName()
      Returns:
      The name of the project

    • projectGroupName

      @Parameter java.lang.String projectGroupName()
      Returns:
      The group name of the project

    • projectModules

      @Parameter java.util.List<java.lang.String> projectModules()
      Returns:
      The project modules

    • release

      @Parameter java.lang.String release()
      Returns:
      The version number of the current release

    • centralReposPath

      @Parameter java.lang.String centralReposPath()
      Returns:
      The path to the project within the Central Repository

    • header

      @Parameter java.util.Optional<java.nio.file.Path> header()
      Returns:
      An XHTML file containing a header inserted above the title and logo in generated sites.

    • overview

      @Parameter java.util.Optional<java.nio.file.Path> overview()
      Returns:
      An XHTML file containing an overview of the project

    • features

      @Parameter java.util.Optional<java.nio.file.Path> features()
      Returns:
      An XHTML file containing the features of the project

    • documentation

      @Parameter java.util.Optional<java.nio.file.Path> documentation()
      Returns:
      An XHTML file containing the documentation links of the project

    • changelog

      @Parameter java.util.Optional<MinChangesConfiguration> changelog()
      Returns:
      The changelog configuration, if any

    • license

      @Parameter java.util.Optional<java.nio.file.Path> license()
      Returns:
      A plain text file containing the project license

    • bugTracker

      @Parameter java.util.Optional<MinBugTrackerConfiguration> bugTracker()
      Returns:
      The bug tracker configuration, if any

    • sources

      @Parameter java.util.Optional<MinSourcesConfiguration> sources()
      Returns:
      The project source configuration, if any

    • cssIncludes

      @Parameter @Default default java.util.List<java.lang.String> cssIncludes()
      Returns:
      The list of stylesheets that will be included by the generated site

    • cssGenerateStyle

      @Default @Parameter default boolean cssGenerateStyle()
      Returns:
      true if the default style should be copied to the generated site directory