diff --git a/.gitignore b/.gitignore index d6b333a..7ad22db 100644 --- a/.gitignore +++ b/.gitignore @@ -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 diff --git a/docs/antora-playbook.yml b/docs/antora-playbook.yml new file mode 100644 index 0000000..c44ad2b --- /dev/null +++ b/docs/antora-playbook.yml @@ -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 diff --git a/docs/antora.yml b/docs/antora.yml new file mode 100644 index 0000000..eb47e2a --- /dev/null +++ b/docs/antora.yml @@ -0,0 +1,5 @@ +name: product-knowledge +version: '1.0' +title: Product Knowledge Documentation +nav: + - modules/ROOT/nav.adoc \ No newline at end of file diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc new file mode 100644 index 0000000..8150eaf --- /dev/null +++ b/docs/modules/ROOT/nav.adoc @@ -0,0 +1,8 @@ + +* xref:index.adoc[Einführung] +* xref:setup.adoc[Installation & Setup] + +* Ebenen + ** xref:ebenen.adoc[Ebenen] + +* API Dokumentation diff --git a/docs/modules/ROOT/pages/ebenen.adoc b/docs/modules/ROOT/pages/ebenen.adoc new file mode 100644 index 0000000..d13f536 --- /dev/null +++ b/docs/modules/ROOT/pages/ebenen.adoc @@ -0,0 +1 @@ +Folgende Ebenen sind vorgesehen: diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc new file mode 100644 index 0000000..98618db --- /dev/null +++ b/docs/modules/ROOT/pages/index.adoc @@ -0,0 +1 @@ +Allerhand Text index \ No newline at end of file diff --git a/docs/modules/ROOT/pages/setup.adoc b/docs/modules/ROOT/pages/setup.adoc new file mode 100644 index 0000000..9ca6768 --- /dev/null +++ b/docs/modules/ROOT/pages/setup.adoc @@ -0,0 +1 @@ +Hier text zum Setup \ No newline at end of file diff --git a/docs/pom.xml b/docs/pom.xml index 5a3b6d3..e0c1ff7 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -13,32 +13,73 @@ + + + + + + + + + + + + + + + + + + + + + + + + + - org.asciidoctor - asciidoctor-maven-plugin - + com.github.eirslett + frontend-maven-plugin + 1.15.0 + - generate-docs - prepare-package + install-node-and-npm - process-asciidoc + install-node-and-npm - - - ${project.basedir}/.. - ${project.parent.name} - ${project.version} - ${project.basedir}/.. - ${project.version} - ${maven.build.timestamp} - coderay - + v20.10.0 + + + + + + npm-install-antora + generate-resources + + npm + + + install @antora/cli@3.1 @antora/site-generator@3.1 + + + + + + run-antora + prepare-package + + npx + + + antora antora-playbook.yml + \ No newline at end of file