michael-simons / asciidoctor-maven-plugin

A Maven plugin that uses Asciidoctor via JRuby to process AsciiDoc source files within the project.

Asciidoctor Maven Tools (Plugin & Site Integration)

The Asciidoctor Maven Plugin is the official way to convert your AsciiDoc documentation using Asciidoctor from an Apache Maven build.

The conversion can happen in 2 flavors:

1. as a Maven plugin: AsciiDoc files are converted at full Asciidoctor power independently from Maven site,

2. as a Maven site integration: AsciiDoc files are integrated with Maven reports, which comes with a few limitations (see below for details).

Full documentations is available in the USER MANUAL.

Translations of the document are available in the following languages:

• 汉语

📎	You’re viewing the documentation for the upcoming release. If you’re looking for the documentation for an older release, please refer to one of the following tags: 2.2.3 ⁃ 2.1.0 ⁃ 2.0.0 ⁃ 1.6.0 ⁃ 1.5.8 ⁃ 1.5.7.1 ⁃ 1.5.6 ⁃ 1.5.5 ⁃ 1.5.3 ⁃ 1.5.2.1

• Quickstart
• Examples
• Maven compatible versions
• Contributing
• Copyright and License

Quickstart

These are the minimal steps to convert your AsciiDoc documents to HTML with the asciidoctor-maven-plugin.

1. Place your AsciiDoc sources in src/docs/asciidoc.

2. Add the minimal configuration to your pom.xml.

   <plugin>
       <groupId>org.asciidoctor</groupId>
       <artifactId>asciidoctor-maven-plugin</artifactId>
       <version>${asciidoctor.maven.plugin.version}</version>
       <executions>
           <execution>
               <id>asciidoc-to-html</id>
               <phase>generate-resources</phase>
               <goals>
                   <goal>process-asciidoc</goal>
               </goals>
           </execution>
       </executions>
   </plugin>

3. Run the plugin’s associated phase.

   $ mvn generate-resources

Examples

You can find examples ready to copy-paste in the Asciidoctor Maven examples project.

Maven compatible versions

asciidoctor-maven-plugin supports Maven 3.8.5+ and 3.9.x versions.

Contributing

This plugin is an open source project made possible with the help of users and enthusiasts. To continue to be useful and to evolve, this plugin needs continuing contributions. There are multiple ways where you can help:

• join the discussions

• give feedback on ideas

• report issue

• test new releases

• contribute source code to fix issues or add new functionality

• write documentation

The Contributor Guide will help you start with the code.

Copyright and License

Copyright © 2013-2020 Jason Porter, Dan Allen, Abel Salgado Romero and the individual contributors. Use of this software is granted under the terms of the Apache License, Version 2.0.

See the LICENSE for the full license text.