https://github.com/eitco/html-maven-plugin

This maven plugin adds a build lifecycle to build and deploy html sites from asciidoc and markdown files
https://github.com/eitco/html-maven-plugin

Last synced: 11 months ago
JSON representation

This maven plugin adds a build lifecycle to build and deploy html sites from asciidoc and markdown files

• Host: GitHub
• URL: https://github.com/eitco/html-maven-plugin
• Owner: eitco
• License: mit
• Created: 2024-07-24T07:50:31.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2025-02-06T10:46:21.000Z (over 1 year ago)
• Last Synced: 2025-02-06T11:35:50.389Z (over 1 year ago)
• Language: Java
• Size: 30.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          

[![License](https://img.shields.io/github/license/eitco/html-maven-plugin.svg?style=for-the-badge)](https://opensource.org/license/mit)

[![Build status](https://img.shields.io/github/actions/workflow/status/eitco/html-maven-plugin/deploy.yaml?branch=main&style=for-the-badge&logo=github)](https://github.com/eitco/html-maven-plugin/actions/workflows/deploy.yaml)

[![Maven Central Version](https://img.shields.io/maven-central/v/de.eitco.cicd.html/html-maven-plugin?style=for-the-badge&logo=apachemaven)](https://central.sonatype.com/artifact/de.eitco.cicd.html/html-maven-plugin)

# html-maven-plugin

This maven plugin adds a build lifecycle to build and deploy html sites from asciidoc and markdown files. It 

deploys the generated html either as a directory - on file after another - or as zip file.

# usage

To add this plugin to your build add the following to your pom:

```xml

...

    

        

            de.eitco.cicd.html

            html-maven-plugin

            4.0.1

            true

        

    

```

Now you can activate one of the lifecycles this plugin provides. To generate a directory containing your 

generated html files and resources use the `html` lifecycle:

```xml

    4.0.0

    your.group.id

    your-artifact-id

    0.0.1-SNAPSHOT

    html

...

```

To generate a zip containing your generated html files and resources us the `html-zip` lifecycle 

```xml

    4.0.0

    your.group.id

    your-artifact-id

    0.0.1-SNAPSHOT

    html-zip

...

```

Add your asciidoc file to `src/main/asciidoc`, your images and plain html files to `src/main/web-resources` and/or your 

markdown files to `src/main/markdown`. 

 * A complete reference about the goals and parameters of this plugin can be found [here](https://eitco.github.io/html-maven-plugin/plugin-info.html).

 * The [integration tests](./src/it) provide some examples about how to use this plugin