Use README.md as documentation link for JPMS plugins

gradlex-org · Feb 4, 2025 · 996d448 · 996d448
1 parent 87822eb
commit 996d448
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 7 deletions.
diff --git a/src/components/Project.astro b/src/components/Project.astro
@@ -1,7 +1,7 @@
 ---
 import { Icon } from "astro-icon/components";
 
-const { name, description } = Astro.props;
+const { name, description, documentationLink } = Astro.props;
 
 const pluginId = name.toLowerCase().replace(/\s+/g, "-");
 
@@ -31,7 +31,9 @@ function getPluginPortalBadge(): string {
         <Icon name="GitHub" />
       </a>
       <a
-        href={`https://gradlex.org/${pluginId}`}
+        href={documentationLink
+          ? documentationLink
+          : `https://gradlex.org/${pluginId}`}
         class="text-gray-500 hover:underline flex items-center text-2xl"
         target="_blank"
         title="Documentation"

diff --git a/src/components/Projects.astro b/src/components/Projects.astro
@@ -6,6 +6,7 @@ type Project = {
   name: string;
   category: string;
   description: string;
+  documentationLink?: string;
 };
 
 function mapProjectsByCategory(projects: Project[]): Record<string, Project[]> {
@@ -27,7 +28,11 @@ const categorizedProjects = mapProjectsByCategory(projects);
           <h2 class="text-3xl font-bold text-gray-800 mb-4">{category}</h2>
           <div class="grid gap-8 md:grid-cols-2">
             {projects.map((project) => (
-              <Project name={project.name} description={project.description} />
+              <Project
+                name={project.name}
+                description={project.description}
+                documentationLink={project.documentationLink}
+              />
             ))}
           </div>
         </div>

diff --git a/src/data/projects.json b/src/data/projects.json
@@ -17,22 +17,26 @@
   {
     "name": "Extra Java Module Info",
     "category": "Java Module System",
-    "description": "Use legacy Java libraries as Java Modules"
+    "description": "Use legacy Java libraries as Java Modules",
+    "documentationLink": "https://github.com/gradlex-org/extra-java-module-info?tab=readme-ov-file#extra-java-module-info-gradle-plugin"
   },
   {
     "name": "Java Module Dependencies",
     "category": "Java Module System",
-    "description": "Use dependencies from `module-info.java` files"
+    "description": "Use dependencies from `module-info.java` files",
+    "documentationLink": "https://github.com/gradlex-org/java-module-dependencies?tab=readme-ov-file#java-module-dependencies-gradle-plugin"
   },
   {
     "name": "Java Module Testing",
     "category": "Java Module System",
-    "description": "Turn Test Suites into Blackbox or Whitebox Test Suites"
+    "description": "Turn Test Suites into Blackbox or Whitebox Test Suites",
+    "documentationLink": "https://github.com/gradlex-org/java-module-testing?tab=readme-ov-file#java-module-testing-gradle-plugin"
   },
   {
     "name": "Java Module Packaging",
     "category": "Java Module System",
-    "description": "Package stand-alone Java applications for multiple systems"
+    "description": "Package stand-alone Java applications for multiple systems",
+    "documentationLink": "https://github.com/gradlex-org/java-module-packaging?tab=readme-ov-file#java-module-packaging-gradle-plugin"
   },
   {
     "name": "Maven Plugin Development",