Package com.github.robtimus.maven.plugins.buildhelper

Class SiteIndexMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.github.robtimus.maven.plugins.buildhelper.SiteIndexMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="site-index",
      defaultPhase=PRE_SITE,
      requiresProject=true,
      threadSafe=true)
public class SiteIndexMojo
extends org.apache.maven.plugin.AbstractMojo

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.

Author:

Rob Spoor

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
SiteIndexMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SiteIndexMojo

public SiteIndexMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException