Add external link indicators to API docs in Antora

Closes gh-40817
spring-projects · May 17, 2024 · b082e5d · b082e5d
1 parent 6f25951
commit b082e5d
Show file tree

Hide file tree

Showing 8 changed files with 30 additions and 37 deletions.
diff --git a/antora/package-lock.json b/antora/package-lock.json
diff --git 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
@@ -40,7 +40,8 @@ public final class Extensions {
 	static {
 		List<Extension> 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
@@ -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
@@ -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/...ot-project/spring-boot-docs/src/docs/antora/modules/ROOT/partials/nav-root.adoc b/...ot-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/...project/spring-boot-docs/src/docs/antora/modules/api/partials/nav-java-api.adoc b/...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/...oject/spring-boot-docs/src/docs/antora/modules/api/partials/nav-kotlin-api.adoc b/...oject/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]