Built by Maven

build-helper:site-index

Full name:

com.github.robtimus:build-helper-maven-plugin:1.1.1:site-index

Description:

Generate a Markdown site index based on another Markdown file. This goal will provide the following transformations:
  • Add an HTML title.
  • Make any link that starts with the project's URL relative to that URL.
  • Remove any badges that match any of a set of provided patterns. Badges will be removed if:
    • They are preceded by a space. In this case, the leading space is removed as well.
    • They are on a line of their own. In this case, the entire line is removed.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: pre-site.

Required Parameters

Name Type Since Description
<siteIndexTitle> String 1.0 The HTML title to add.
Default value is: Overview.
<sourceFile> File - The source Markdown file. 1.0
Default value is: ${project.basedir}/README.md.
<targetFile> File 1.0 The Markdown site index to generate.
Default value is: ${project.basedir}/src/site/markdown/index.md.

Optional Parameters

Name Type Since Description
<badgePatterns> String[] 1.0 A set of patterns to use to recognize badges, based on the URL.
<encoding> String 1.0 The encoding to use for reading and writing the site index.
Default value is: ${project.build.sourceEncoding}.
<skipSiteIndex> boolean 1.0 Set this to true to skip generating a Markdown site index.
Default value is: false.
User property is: robtimus.site-index.skip.

Parameter Details

<badgePatterns>

A set of patterns to use to recognize badges, based on the URL.
  • Type: java.lang.String[]
  • Since: 1.0
  • Required: No

<encoding>

The encoding to use for reading and writing the site index.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Default: ${project.build.sourceEncoding}

<siteIndexTitle>

The HTML title to add.
  • Type: java.lang.String
  • Since: 1.0
  • Required: Yes
  • Default: Overview

<skipSiteIndex>

Set this to true to skip generating a Markdown site index.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: robtimus.site-index.skip
  • Default: false

<sourceFile>

The source Markdown file. 1.0
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.basedir}/README.md

<targetFile>

The Markdown site index to generate.
  • Type: java.io.File
  • Since: 1.0
  • Required: Yes
  • Default: ${project.basedir}/src/site/markdown/index.md