Getting Started

Minimal pom.xml — doc-only project

<project xmlns="http://maven.apache.org/POM/4.1.0" ...>
    <modelVersion>4.1.0</modelVersion>

    <parent>
        <groupId>network.ike.platform</groupId>
        <artifactId>ike-parent</artifactId>
        <version>26</version>
        <relativePath/>          <!-- force repo lookup; see ike-issues#323 -->
    </parent>

    <groupId>com.example</groupId>
    <artifactId>my-document</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <packaging>pom</packaging>   <!-- doc-only: pom packaging post-#321 -->

    <name>My IKE Document</name>
</project>

The AsciiDoc source payload is auto-attached as a <classifier>adoc</classifier><type>zip</type> artifact when src/docs/asciidoc/ exists. Renderer outputs (PDF, HTML) attach as additional classifiers when their toggles are enabled.

<relativePath/> (empty self-closing element) forces Maven to resolve ike-parent from the local repository / Nexus rather than traversing the filesystem. Required when your project lives inside a workspace aggregator that itself inherits the same parent (see IKE-Network/ike-issues#323).

Document structure

Place your AsciiDoc content in the standard location:

my-document/
├── pom.xml
└── src/
    └── docs/
        └── asciidoc/
            ├── index.adoc          (1)
            ├── chapters/
            │   ├── introduction.adoc
            │   └── methodology.adoc
            └── images/
                └── architecture.png

Build HTML

mvn clean verify

HTML output lands in target/generated-docs/html/. The HTML profile is active by default.

Build PDF

mvn clean verify -Dike.pdf.prawn

The Prawn renderer is free and built-in — no external tool installation required. PDF output lands in target/generated-docs/pdf-prawn/.

Multiple renderers

Profiles are composable. Activate several at once:

mvn clean verify -Dike.pdf.prawn -Dike.pdf.prince -Dike.html.single

Minimal pom.xml

<project xmlns="http://maven.apache.org/POM/4.1.0" ...>
    <modelVersion>4.1.0</modelVersion>

    <parent>
        <groupId>network.ike.platform</groupId>
        <artifactId>ike-parent</artifactId>
        <version>26</version>
        <relativePath/>
    </parent>

    <groupId>com.example</groupId>
    <artifactId>my-project</artifactId>
    <version>1.0.0-SNAPSHOT</version>

    <name>My IKE Project</name>
</project>

ike-parent provides Java 25 compiler config, test framework versions, JPMS --add-opens for surefire/failsafe, signing, javadoc, and the rest of the Java toolchain — there is no separate java-parent (the previously-distinct java-parent was retired in IKE-Network/ike-issues#216).

Java source goes in src/main/java/ as usual. Documentation goes in src/docs/asciidoc/. Both compile and render in a single mvn clean verify. The doc-pipeline profile auto-activates on src/docs/asciidoc/ existence — no per-module declaration needed.