Built by Maven

html:from-asciidoc

Full name:

de.eitco.cicd.html:html-maven-plugin:4.0.2:from-asciidoc

Description:

This goal generates html files from asciidoc source files. It is built on top of the AsciidoctorMojo from the asciidoctor maven plugin and adapts it to align with the defined build lifecycle.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Binds by default to the lifecycle phase: compile.

Optional Parameters

Name Type Since Description
<attributes> Map<String,Object> - No description.
<attributesChain> String - No description.
User Property: asciidoctor.attributes
<backend> String - No description.
Default: html5
User Property: asciidoctor.backend
<baseDir> File - No description.
User Property: asciidoctor.baseDir
<catalogAssets> boolean - No description.
User Property: asciidoctor.catalogAssets
<doctype> String - No description.
User Property: asciidoctor.doctype
<embedAssets> boolean - No description.
User Property: asciidoctor.embedAssets
<enableVerbose> boolean - No description.
User Property: asciidoctor.verbose
<encoding> String - No description.
Default: ${project.build.sourceEncoding}
<eruby> String - No description.
User Property: asciidoctor.eruby
<extensions> List<ExtensionConfiguration> - No description.
<gemPath> String - No description.
User Property: asciidoctor.gemPath
<headerFooter> boolean - No description.
User Property: asciidoctor.headerFooter
<logHandler> LogHandler - No description.
<outputDirectory> File - This parameter specifies where to put the generated html file(s).
Default: ${project.build.directory}/html
User Property: asciidoctor.outputDirectory
<outputFile> File - No description.
User Property: asciidoctor.outputFile
<preserveDirectories> boolean - This parameter specifies whether to preserve the directory structure in the output.
Default: true
User Property: asciidoctor.preserveDirectories
<projectDirectory> File - No description.
Default: ${basedir}
User Property: asciidoctor.projectDirectory
<relativeBaseDir> boolean - No description.
Default: false
User Property: asciidoctor.relativeBaseDir
<requires> List<String> - No description.
User Property: asciidoctor.requires
<resources> List<Resource> - No description.
<rootDir> File - No description.
Default: ${basedir}
User Property: asciidoctor.rootDir
<skip> boolean - No description.
User Property: asciidoctor.skip
<sourceDirectory> File - No description.
Default: ${basedir}/src/docs/asciidoc
User Property: asciidoctor.sourceDirectory
<sourceDocumentExtensions> List<String> - No description.
User Property: asciidoctor.sourceDocumentExtensions
<sourceDocumentName> String - No description.
User Property: asciidoctor.sourceDocumentName
<sourcemap> boolean - No description.
User Property: asciidoctor.sourcemap
<templateCache> boolean - No description.
User Property: asciidoctor.templateCache
<templateDirs> List<File> - No description.
User Property: asciidoctor.templateDirs
<templateEngine> String - No description.
User Property: asciidoctor.templateEngine

Parameter Details

<attributes>

No description.
  • Type: java.util.Map<java.lang.String, java.lang.Object>
  • Required: No

<attributesChain>

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: asciidoctor.attributes

<backend>

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: asciidoctor.backend
  • Default: html5

<baseDir>

No description.
  • Type: java.io.File
  • Required: No
  • User Property: asciidoctor.baseDir

<catalogAssets>

No description.
  • Type: boolean
  • Required: No
  • User Property: asciidoctor.catalogAssets

<doctype>

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: asciidoctor.doctype

<embedAssets>

No description.
  • Type: boolean
  • Required: No
  • User Property: asciidoctor.embedAssets

<enableVerbose>

No description.
  • Type: boolean
  • Required: No
  • User Property: asciidoctor.verbose

<encoding>

No description.
  • Type: java.lang.String
  • Required: No
  • Default: ${project.build.sourceEncoding}

<eruby>

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: asciidoctor.eruby

<extensions>

No description.
  • Type: java.util.List<org.asciidoctor.maven.extensions.ExtensionConfiguration>
  • Required: No

<gemPath>

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: asciidoctor.gemPath

<headerFooter>

No description.
  • Type: boolean
  • Required: No
  • User Property: asciidoctor.headerFooter

<logHandler>

No description.
  • Type: org.asciidoctor.maven.log.LogHandler
  • Required: No

<outputDirectory>

This parameter specifies where to put the generated html file(s).
  • Type: java.io.File
  • Required: No
  • User Property: asciidoctor.outputDirectory
  • Default: ${project.build.directory}/html

<outputFile>

No description.
  • Type: java.io.File
  • Required: No
  • User Property: asciidoctor.outputFile

<preserveDirectories>

This parameter specifies whether to preserve the directory structure in the output.
  • Type: boolean
  • Required: No
  • User Property: asciidoctor.preserveDirectories
  • Default: true

<projectDirectory>

No description.
  • Type: java.io.File
  • Required: No
  • User Property: asciidoctor.projectDirectory
  • Default: ${basedir}

<relativeBaseDir>

No description.
  • Type: boolean
  • Required: No
  • User Property: asciidoctor.relativeBaseDir
  • Default: false

<requires>

No description.
  • Type: java.util.List<java.lang.String>
  • Required: No
  • User Property: asciidoctor.requires

<resources>

No description.
  • Type: java.util.List<org.apache.maven.model.Resource>
  • Required: No

<rootDir>

No description.
  • Type: java.io.File
  • Required: No
  • User Property: asciidoctor.rootDir
  • Default: ${basedir}

<skip>

No description.
  • Type: boolean
  • Required: No
  • User Property: asciidoctor.skip

<sourceDirectory>

No description.
  • Type: java.io.File
  • Required: No
  • User Property: asciidoctor.sourceDirectory
  • Default: ${basedir}/src/docs/asciidoc

<sourceDocumentExtensions>

No description.
  • Type: java.util.List<java.lang.String>
  • Required: No
  • User Property: asciidoctor.sourceDocumentExtensions

<sourceDocumentName>

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: asciidoctor.sourceDocumentName

<sourcemap>

No description.
  • Type: boolean
  • Required: No
  • User Property: asciidoctor.sourcemap

<templateCache>

No description.
  • Type: boolean
  • Required: No
  • User Property: asciidoctor.templateCache

<templateDirs>

No description.
  • Type: java.util.List<java.io.File>
  • Required: No
  • User Property: asciidoctor.templateDirs

<templateEngine>

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: asciidoctor.templateEngine