Antora für Dokumentation.

This commit is contained in:
2026-01-17 17:45:30 +01:00
parent cfc276242f
commit a13d950140
8 changed files with 90 additions and 16 deletions

6
.gitignore vendored
View File

@@ -7,6 +7,12 @@ target/
### schließe node aus ### schließe node aus
web-frontend/node/ web-frontend/node/
# Node.js Artefakte im docs Modul
docs/node/
docs/node_modules/
# Antora Output (Standardmäßig im Ordner 'build' oder 'public')
docs/build/
### IntelliJ IDEA ### ### IntelliJ IDEA ###
.idea/modules.xml .idea/modules.xml
.idea/jarRepositories.xml .idea/jarRepositories.xml

11
docs/antora-playbook.yml Normal file
View File

@@ -0,0 +1,11 @@
site:
title: Product Knowledge Docs
start_page: ROOT:index.adoc
content:
sources:
- url: ..
branches: HEAD
start_path: docs
ui:
bundle:
url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable

5
docs/antora.yml Normal file
View File

@@ -0,0 +1,5 @@
name: product-knowledge
version: '1.0'
title: Product Knowledge Documentation
nav:
- modules/ROOT/nav.adoc

View File

@@ -0,0 +1,8 @@
* xref:index.adoc[Einführung]
* xref:setup.adoc[Installation & Setup]
* Ebenen
** xref:ebenen.adoc[Ebenen]
* API Dokumentation

View File

@@ -0,0 +1 @@
Folgende Ebenen sind vorgesehen:

View File

@@ -0,0 +1 @@
Allerhand Text index

View File

@@ -0,0 +1 @@
Hier text zum Setup

View File

@@ -13,32 +13,73 @@
<build> <build>
<plugins> <plugins>
<!-- <plugin>-->
<!-- <groupId>org.asciidoctor</groupId>-->
<!-- <artifactId>asciidoctor-maven-plugin</artifactId>-->
<!-- &lt;!&ndash; Keine Version nötig, kommt vom Parent &ndash;&gt;-->
<!-- <executions>-->
<!-- <execution>-->
<!-- <id>generate-docs</id>-->
<!-- <phase>prepare-package</phase>-->
<!-- <goals>-->
<!-- <goal>process-asciidoc</goal>-->
<!-- </goals>-->
<!-- <configuration>-->
<!-- <attributes>-->
<!-- <project-root>${project.basedir}/..</project-root>-->
<!-- <project-name>${project.parent.name}</project-name>-->
<!-- <project-version>${project.version}</project-version>-->
<!-- <project-root>${project.basedir}/..</project-root>-->
<!-- <revnumber>${project.version}</revnumber>-->
<!-- <revdate>${maven.build.timestamp}</revdate>-->
<!-- <source-highlighter>coderay</source-highlighter>-->
<!-- </attributes>-->
<!-- </configuration>-->
<!-- </execution>-->
<!-- </executions>-->
<!-- </plugin>-->
<plugin> <plugin>
<groupId>org.asciidoctor</groupId> <groupId>com.github.eirslett</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId> <artifactId>frontend-maven-plugin</artifactId>
<!-- Keine Version nötig, kommt vom Parent --> <version>1.15.0</version>
<executions> <executions>
<!-- 1. Node.js und npm lokal im docs-Verzeichnis installieren -->
<execution> <execution>
<id>generate-docs</id> <id>install-node-and-npm</id>
<phase>prepare-package</phase>
<goals> <goals>
<goal>process-asciidoc</goal> <goal>install-node-and-npm</goal>
</goals> </goals>
<configuration> <configuration>
<attributes> <nodeVersion>v20.10.0</nodeVersion>
<!-- Pfad-Helper, um auf Code in anderen Modulen zuzugreifen --> </configuration>
<project-root>${project.basedir}/..</project-root> </execution>
<project-name>${project.parent.name}</project-name>
<project-version>${project.version}</project-version> <!-- 2. Antora lokal installieren -->
<project-root>${project.basedir}/..</project-root> <execution>
<revnumber>${project.version}</revnumber> <id>npm-install-antora</id>
<revdate>${maven.build.timestamp}</revdate> <phase>generate-resources</phase>
<source-highlighter>coderay</source-highlighter> <goals>
</attributes> <goal>npm</goal>
</goals>
<configuration>
<arguments>install @antora/cli@3.1 @antora/site-generator@3.1</arguments>
</configuration>
</execution>
<!-- 3. Antora ausführen, um die Seite zu bauen -->
<execution>
<id>run-antora</id>
<phase>prepare-package</phase>
<goals>
<goal>npx</goal>
</goals>
<configuration>
<arguments>antora antora-playbook.yml</arguments>
</configuration> </configuration>
</execution> </execution>
</executions> </executions>
</plugin> </plugin>
</plugins> </plugins>
</build> </build>
</project> </project>