diff --git a/antora/package-lock.json b/antora/package-lock.json index 20b64670856e..dc5a06083253 100644 --- a/antora/package-lock.json +++ b/antora/package-lock.json @@ -9,7 +9,7 @@ "@antora/cli": "3.2.0-alpha.4", "@antora/site-generator": "3.2.0-alpha.4", "@asciidoctor/tabs": "1.0.0-beta.6", - "@springio/antora-extensions": "1.8.2", + "@springio/antora-extensions": "1.11.0", "@springio/antora-xref-extension": "1.0.0-alpha.3", "@springio/antora-zip-contents-collector-extension": "1.0.0-alpha.8", "@springio/asciidoctor-extensions": "1.0.0-alpha.10" @@ -313,14 +313,15 @@ "integrity": "sha512-trnsAYxU3xnS1gPHPyU961coFyLkh4gAD/0zQ5mymY4yOZ+CYvsPqUbOFSw0aDM4y0tV7tiFxL/1XfXPNC6IPg==" }, "node_modules/@springio/antora-extensions": { - "version": "1.8.2", - "resolved": "https://registry.npmjs.org/@springio/antora-extensions/-/antora-extensions-1.8.2.tgz", - "integrity": "sha512-f5DabIgJ/k5+V8KA8un5w7fAo/vtRKe7N8vX82XJTohAE1ikpSwMlOYpPgDwIh4KzPfcRVMLJ2GYxo+WPBYR6g==", + "version": "1.11.0", + "resolved": "https://registry.npmjs.org/@springio/antora-extensions/-/antora-extensions-1.11.0.tgz", + "integrity": "sha512-WytgbkbDMG0StVa/ijRZJ1b8PgeNqrKAh1BwXaG8g8PP5VzFvvvLnF7w/UZib+3LdwmheA1dgE+IjkqKIAt28g==", "dependencies": { "@antora/expand-path-helper": "~2.0", "archiver": "^5.3.1", "asciinema-player": "^3.6.1", "cache-directory": "~2.0", + "ci": "^2.3.0", "decompress": "4.2.1", "fast-xml-parser": "latest", "handlebars": "latest" @@ -702,6 +703,17 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/ci": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/ci/-/ci-2.3.0.tgz", + "integrity": "sha512-0MGXkzJKkwV3enG7RUxjJKdiAkbaZ7visCjitfpCN2BQjv02KGRMxCHLv4RPokkjJ4xR33FLMAXweS+aQ0pFSQ==", + "bin": { + "ci": "dist/cli.js" + }, + "funding": { + "url": "https://github.com/privatenumber/ci?sponsor=1" + } + }, "node_modules/clean-git-ref": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/clean-git-ref/-/clean-git-ref-2.0.1.tgz", diff --git a/antora/package.json b/antora/package.json index e929c9623202..b51ab68925c7 100644 --- a/antora/package.json +++ b/antora/package.json @@ -6,7 +6,7 @@ "@antora/cli": "3.2.0-alpha.4", "@antora/site-generator": "3.2.0-alpha.4", "@antora/atlas-extension": "1.0.0-alpha.2", - "@springio/antora-extensions": "1.8.2", + "@springio/antora-extensions": "1.11.0", "@springio/antora-xref-extension": "1.0.0-alpha.3", "@springio/antora-zip-contents-collector-extension": "1.0.0-alpha.8", "@asciidoctor/tabs": "1.0.0-beta.6", diff --git a/buildSrc/src/main/java/org/springframework/boot/build/antora/Extensions.java b/buildSrc/src/main/java/org/springframework/boot/build/antora/Extensions.java index ac11fd6c8025..8234edfea98a 100644 --- a/buildSrc/src/main/java/org/springframework/boot/build/antora/Extensions.java +++ b/buildSrc/src/main/java/org/springframework/boot/build/antora/Extensions.java @@ -40,7 +40,8 @@ public final class Extensions { static { List extensions = new ArrayList<>(); extensions.add(new Extension("@springio/antora-extensions", ROOT_COMPONENT_EXTENSION, - "@springio/antora-extensions/static-page-extension")); + "@springio/antora-extensions/static-page-extension", + "@springio/antora-extensions/override-navigation-builder-extension")); extensions.add(new Extension("@springio/antora-xref-extension")); extensions.add(new Extension("@springio/antora-zip-contents-collector-extension")); antora = List.copyOf(extensions); diff --git a/buildSrc/src/test/resources/org/springframework/boot/build/antora/expected-playbook.yml b/buildSrc/src/test/resources/org/springframework/boot/build/antora/expected-playbook.yml index 0972568108b5..5f7f86a73d8a 100644 --- a/buildSrc/src/test/resources/org/springframework/boot/build/antora/expected-playbook.yml +++ b/buildSrc/src/test/resources/org/springframework/boot/build/antora/expected-playbook.yml @@ -1,5 +1,6 @@ antora: extensions: + - require: '@springio/antora-extensions/override-navigation-builder-extension' - require: '@springio/antora-extensions/static-page-extension' - require: '@springio/antora-xref-extension' stub: diff --git a/spring-boot-project/spring-boot-docs/src/docs/antora/antora.yml b/spring-boot-project/spring-boot-docs/src/docs/antora/antora.yml index 0b9312fb9833..86bca2047644 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/antora/antora.yml +++ b/spring-boot-project/spring-boot-docs/src/docs/antora/antora.yml @@ -9,24 +9,3 @@ ext: classifier: catalog-content module: api destination: content-catalog - nav-attributes: - - path: "Overview" - attributes: { icon: home } - - path: "Documentation" - attributes: { icon: book } - - path: "Community" - attributes: { icon: question } - - path: "System Requirements" - attributes: { icon: server } - - path: "Installing Spring Boot" - attributes: { icon: gift } - - path: "Upgrading Spring Boot" - attributes: { icon: rocket } - - path: [ "Java APIs", "Spring Boot" ] - attributes: { external: true } - - path: [ "Java APIs", "Maven Plugin" ] - attributes: { external: true} - - path: [ "Java APIs", "Gradle Plugin" ] - attributes: { external: true } - - path: [ "Kotlin APIs", "Spring Boot" ] - attributes: { external: true } diff --git a/spring-boot-project/spring-boot-docs/src/docs/antora/modules/ROOT/partials/nav-root.adoc b/spring-boot-project/spring-boot-docs/src/docs/antora/modules/ROOT/partials/nav-root.adoc index 429990ca3b04..01a331853fae 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/antora/modules/ROOT/partials/nav-root.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/antora/modules/ROOT/partials/nav-root.adoc @@ -1,6 +1,6 @@ -* xref:index.adoc[] -* xref:documentation.adoc[] -* xref:community.adoc[] -* xref:system-requirements.adoc[] -* xref:installing.adoc[] -* xref:upgrading.adoc[] +* xref:index.adoc[,role=navtree-icon-home] +* xref:documentation.adoc[,role=navtree-icon-book] +* xref:community.adoc[,role=navtree-icon-question] +* xref:system-requirements.adoc[,role=navtree-icon-server] +* xref:installing.adoc[,role=navtree-icon-gift] +* xref:upgrading.adoc[,role=navtree-icon-rocket] diff --git a/spring-boot-project/spring-boot-docs/src/docs/antora/modules/api/partials/nav-java-api.adoc b/spring-boot-project/spring-boot-docs/src/docs/antora/modules/api/partials/nav-java-api.adoc index 08b90ed30148..88c2f5ea8e81 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/antora/modules/api/partials/nav-java-api.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/antora/modules/api/partials/nav-java-api.adoc @@ -1,4 +1,4 @@ * Java APIs -** xref:api:java/index.html[Spring Boot] -** xref:gradle-plugin:api/java/index.html[Gradle Plugin] -** xref:maven-plugin:api/java/index.html[Maven Plugin] +** xref:api:java/index.html[Spring Boot,role=link-external, window=_blank] +** xref:gradle-plugin:api/java/index.html[Gradle Plugin,role=link-external, window=_blank] +** xref:maven-plugin:api/java/index.html[Maven Plugin,role=link-external, window=_blank] diff --git a/spring-boot-project/spring-boot-docs/src/docs/antora/modules/api/partials/nav-kotlin-api.adoc b/spring-boot-project/spring-boot-docs/src/docs/antora/modules/api/partials/nav-kotlin-api.adoc index ccc8b74522bc..d6ee79d2ecd4 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/antora/modules/api/partials/nav-kotlin-api.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/antora/modules/api/partials/nav-kotlin-api.adoc @@ -1,2 +1,2 @@ * Kotlin APIs -** xref:api:kotlin/index.html[Spring Boot] +** xref:api:kotlin/index.html[Spring Boot,role=link-external, window=_blank]