Antora für Dokumentation.
This commit is contained in:
6
.gitignore
vendored
6
.gitignore
vendored
@@ -7,6 +7,12 @@ target/
|
||||
### schließe node aus
|
||||
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 ###
|
||||
.idea/modules.xml
|
||||
.idea/jarRepositories.xml
|
||||
|
||||
11
docs/antora-playbook.yml
Normal file
11
docs/antora-playbook.yml
Normal 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
5
docs/antora.yml
Normal file
@@ -0,0 +1,5 @@
|
||||
name: product-knowledge
|
||||
version: '1.0'
|
||||
title: Product Knowledge Documentation
|
||||
nav:
|
||||
- modules/ROOT/nav.adoc
|
||||
8
docs/modules/ROOT/nav.adoc
Normal file
8
docs/modules/ROOT/nav.adoc
Normal file
@@ -0,0 +1,8 @@
|
||||
|
||||
* xref:index.adoc[Einführung]
|
||||
* xref:setup.adoc[Installation & Setup]
|
||||
|
||||
* Ebenen
|
||||
** xref:ebenen.adoc[Ebenen]
|
||||
|
||||
* API Dokumentation
|
||||
1
docs/modules/ROOT/pages/ebenen.adoc
Normal file
1
docs/modules/ROOT/pages/ebenen.adoc
Normal file
@@ -0,0 +1 @@
|
||||
Folgende Ebenen sind vorgesehen:
|
||||
1
docs/modules/ROOT/pages/index.adoc
Normal file
1
docs/modules/ROOT/pages/index.adoc
Normal file
@@ -0,0 +1 @@
|
||||
Allerhand Text index
|
||||
1
docs/modules/ROOT/pages/setup.adoc
Normal file
1
docs/modules/ROOT/pages/setup.adoc
Normal file
@@ -0,0 +1 @@
|
||||
Hier text zum Setup
|
||||
73
docs/pom.xml
73
docs/pom.xml
@@ -13,32 +13,73 @@
|
||||
|
||||
<build>
|
||||
<plugins>
|
||||
<!-- <plugin>-->
|
||||
<!-- <groupId>org.asciidoctor</groupId>-->
|
||||
<!-- <artifactId>asciidoctor-maven-plugin</artifactId>-->
|
||||
<!-- <!– Keine Version nötig, kommt vom Parent –>-->
|
||||
<!-- <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>
|
||||
<groupId>org.asciidoctor</groupId>
|
||||
<artifactId>asciidoctor-maven-plugin</artifactId>
|
||||
<!-- Keine Version nötig, kommt vom Parent -->
|
||||
<groupId>com.github.eirslett</groupId>
|
||||
<artifactId>frontend-maven-plugin</artifactId>
|
||||
<version>1.15.0</version>
|
||||
<executions>
|
||||
<!-- 1. Node.js und npm lokal im docs-Verzeichnis installieren -->
|
||||
<execution>
|
||||
<id>generate-docs</id>
|
||||
<phase>prepare-package</phase>
|
||||
<id>install-node-and-npm</id>
|
||||
<goals>
|
||||
<goal>process-asciidoc</goal>
|
||||
<goal>install-node-and-npm</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<attributes>
|
||||
<!-- Pfad-Helper, um auf Code in anderen Modulen zuzugreifen -->
|
||||
<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>
|
||||
<nodeVersion>v20.10.0</nodeVersion>
|
||||
</configuration>
|
||||
</execution>
|
||||
|
||||
<!-- 2. Antora lokal installieren -->
|
||||
<execution>
|
||||
<id>npm-install-antora</id>
|
||||
<phase>generate-resources</phase>
|
||||
<goals>
|
||||
<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>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
|
||||
</plugins>
|
||||
</build>
|
||||
</project>
|
||||
Reference in New Issue
Block a user