Skip to content

AsciiDoctor Diagram support added #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

AsciiDoctor Diagram support added #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Checkstyle validation. Always on by default, can be disabled with `-DskipChecks`

- Automatically generate the Javadocs. Always on by default, can be skipped with `-DskipDocs`

- Automatically generate `pdf` and `html` files from the `src/main/asciidoc` folder.
- Automatically generate `pdf` and `html` files from the `src/main/asciidoc` folder, including AsciiDoctor Diagram support.

- Apply the BND configuration if a `bnd.bnd` exists in the root project.

Expand Down
66 changes: 55 additions & 11 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,14 @@
<version.plugin.checkstyle>3.1.1</version.plugin.checkstyle>
<version.plugin.rat>0.13</version.plugin.rat>
<version.plugin.bnd>5.2.0</version.plugin.bnd>
<version.plugin.asciidoctor>2.1.0</version.plugin.asciidoctor>
<version.plugin.asciidoctor.pdf>1.5.3</version.plugin.asciidoctor.pdf>

<!-- AsciiDoctor support versions -->
<asciidoctor.maven.plugin.version>2.2.2</asciidoctor.maven.plugin.version>
<asciidoctorj.version>2.5.6</asciidoctorj.version>
<asciidoctorj.diagram.version>2.2.3</asciidoctorj.diagram.version>
<asciidoctorj.pdf.version>2.3.0</asciidoctorj.pdf.version>
<jruby.version>9.3.8.0</jruby.version>

<version.plugin.copy.rename>1.0</version.plugin.copy.rename>
<version.plugin.release>2.5.3</version.plugin.release>
<version.plugin.gpg>1.6</version.plugin.gpg>
Expand Down Expand Up @@ -407,16 +413,48 @@
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<version>${version.plugin.asciidoctor}</version>
<version>${asciidoctor.maven.plugin.version}</version>
<dependencies>
<!-- Overwriting default versions provided by the plugin -->
<dependency>
<groupId>org.jruby</groupId>
<artifactId>jruby</artifactId>
<version>${jruby.version}</version>
</dependency>
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctorj</artifactId>
<version>${asciidoctorj.version}</version>
</dependency>
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctorj-diagram</artifactId>
<version>${asciidoctorj.diagram.version}</version>
</dependency>
<!-- Adding AsciiDoctorJ PDF support-->
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctorj-pdf</artifactId>
<version>${asciidoctorj.pdf.version}</version>
</dependency>
</dependencies>
<configuration>
<sourceDocumentName>${project.artifactId}.asciidoc</sourceDocumentName>
<!-- Attributes common to all output formats -->
<attributes>
<sourceHighlighter>coderay</sourceHighlighter>
<revnumber>${project.version}</revnumber>
<revremark>${release.revision}</revremark>
<!--suppress UnresolvedMavenProperty - Generated by build-helper-maven-plugin -->
<revdate>${release.timestamp}</revdate>
<icons>font</icons>
<idprefix/>
<idseparator>-</idseparator>
<!-- Images located to documents source -->
<imagesdir>./image</imagesdir>
</attributes>
<requires>
<require>asciidoctor-diagram</require>
</requires>
</configuration>
<executions>
<execution>
Expand All @@ -428,6 +466,14 @@
<configuration>
<outputFile>${project.build.directory}/generated-docs/${project.build.finalName}.pdf</outputFile>
<backend>pdf</backend>
<doctype>book</doctype>
<!-- Attributes specific to output formats -->
<attributes>
<pagenums/>
<toc/>
<!-- The current verisons of the source highlighters use external static resources in HTML - so use it in PDF version only! -->
<source-highlighter>rouge</source-highlighter>
</attributes>
</configuration>
</execution>
<execution>
Expand All @@ -439,16 +485,14 @@
<configuration>
<outputFile>${project.build.directory}/generated-docs/${project.build.finalName}.html</outputFile>
<backend>html5</backend>
<!-- Attributes specific to output formats -->
<attributes>
<toc>left</toc>
<sectanchors>true</sectanchors>
</attributes>
</configuration>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctorj-pdf</artifactId>
<version>${version.plugin.asciidoctor.pdf}</version>
</dependency>
</dependencies>
</plugin>

<!-- Release -->
Expand Down