https://github.com/dataliquid/asciidoc-maven-plugin

Maven plugin for processing AsciiDoc files with advanced features including diagrams, templates, and linting
https://github.com/dataliquid/asciidoc-maven-plugin

asciidoc asciidoctor ditaa documentation documentation-tool graphviz html-generator incremental-build java linter maven maven-plugin plantuml static-site-generator stringtemplate template-engine yaml-frontmatter

Last synced: 3 months ago
JSON representation

Maven plugin for processing AsciiDoc files with advanced features including diagrams, templates, and linting

• Host: GitHub
• URL: https://github.com/dataliquid/asciidoc-maven-plugin
• Owner: dataliquid
• License: apache-2.0
• Created: 2025-07-10T21:00:45.000Z (9 months ago)
• Default Branch: develop
• Last Pushed: 2025-12-22T12:16:48.000Z (3 months ago)
• Last Synced: 2025-12-22T18:00:17.762Z (3 months ago)
• Topics: asciidoc, asciidoctor, ditaa, documentation, documentation-tool, graphviz, html-generator, incremental-build, java, linter, maven, maven-plugin, plantuml, static-site-generator, stringtemplate, template-engine, yaml-frontmatter
• Language: Java
• Size: 246 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE

Awesome Lists containing this project

README

          
= AsciiDoc Maven Plugin

image:https://github.com/dataliquid/asciidoc-maven-plugin/actions/workflows/ci.yml/badge.svg[CI Build,link=https://github.com/dataliquid/asciidoc-maven-plugin/actions/workflows/ci.yml]

image:https://img.shields.io/maven-central/v/com.dataliquid.maven/asciidoc-maven-plugin.svg[Maven Central,link=https://search.maven.org/artifact/com.dataliquid.maven/asciidoc-maven-plugin]

image:https://img.shields.io/badge/license-Apache%202.0-blue.svg[License,link=https://opensource.org/licenses/Apache-2.0]

image:https://img.shields.io/badge/Java-17%2B-blue.svg[Java Version]

image:https://img.shields.io/badge/Maven-3.9%2B-blue.svg[Maven Version]

A Maven plugin for processing AsciiDoc files with advanced features.

== Overview

[cols="1,3"]

|===

|Group ID |`com.dataliquid.maven`

|Artifact ID |`asciidoc-maven-plugin`

|Version |`0.4.0`

|License |Apache License 2.0

|Requirements |Java 17+, Maven 3.6+

|===

== Features

* *AsciidoctorJ* - Full AsciiDoc to HTML rendering

* *Incremental builds* - SHA-256 based change detection

* *Diagram support* - PlantUML, Ditaa, Graphviz (SVG/PNG)

* *YAML front matter* - Metadata extraction and validation

* *StringTemplate4* - Custom templating support

* *AsciiDoc linting* - Comprehensive validation with asciidoc-linter

== Goals

[cols="1,3"]

|===

|Goal |Description

|`render`

|Convert AsciiDoc files to HTML with template support

|`validate`

|Validate YAML front matter against JSON schema

|`lint`

|Comprehensive AsciiDoc validation and style checking

|===

== Quick Start

[source,xml]

----

    com.dataliquid.maven

    asciidoc-maven-plugin

    0.4.0

    

        

            generate-docs

            generate-resources

            

                render

            

        

    

----

== Key Parameters

[cols="2,1,2,3"]

|===

|Parameter |Type |Default |Description

|`sourceDirectory`

|File

|`src/docs/asciidoc`

|Input directory for AsciiDoc files

|`outputDirectory`

|File

|`target/generated-docs`

|Output directory for HTML files

|`includes`

|String[]

|`**/*.adoc`

|Ant-style include patterns

|`enableDiagrams`

|boolean

|`true`

|Enable diagram rendering

|`enableIncremental`

|boolean

|`true`

|Enable incremental builds

|`safeMode`

|String

|`SAFE`

|AsciidoctorJ safe mode (UNSAFE, SAFE, SERVER, SECURE)

|`ruleFile`

|File

|_required for lint_

|YAML configuration for linter rules

|===

== Front Matter Example

[source,asciidoc]

----

---

title: My Document

author: John Doe

version: 0.1.0

tags: [documentation, guide]

---

= My Document

Document content...

----

== Build

[source,bash]

----

mvn clean install

----