Merge pull request #573 from Strokkur424/feat/adventure

feat: Add Adventure docs

Author: zlataovce

CONTRIBUTING.md

@@ -12,7 +12,8 @@ To ensure a smooth and collaborative contribution process, please follow the gui
 5. [Version tags](#version-tags)
 6. [Automatic constant replacement](#automatic-constant-replacement)
 7. [Linking to Javadocs](#linking-to-javadocs)
-8. [Code of Conduct](#code-of-conduct)
+8. [Referencing a build system dependency](#referencing-a-build-system-dependency)
+9. [Code of Conduct](#code-of-conduct)
 
 ## Introduction
 
@@ -181,6 +182,45 @@ For that, you can use the `jd:project_name[:module_name][:class_or_member_refere
 [java.sql's Connection](jd:java:java.sql:java.sql.Connection)
 ```
 
+## Referencing a build system dependency
+
+If you wish to reference a build system (i.e. Gradle or Maven) dependency, you can use the `Dependency` component.
+
+```mdxjs
+import { LATEST_ADVENTURE_API_RELEASE } from "/src/utils/versions";
+
+{/* uses the "default" template */}
+<Dependency group="net.kyori" name="adventure-api" version={LATEST_ADVENTURE_API_RELEASE} />
+```
+
+The `default` template is fit for use with a simple `implementation`/`compile`-scope dependency from Maven Central,
+however you can also make your own template.
+
+If you need to declare the dependency in a unique way and/or need to add other configuration in the build script, simply use
+the `Tabs` component with the corresponding code blocks - **do not make a template unless you plan to use it more than once**.
+
+```mdxjs
+import { Tabs, TabItem } from "@astrojs/starlight/components";
+
+<Tabs syncKey="build-system">
+  <TabItem label="Gradle (Kotlin)">
+    ```kotlin title="build.gradle.kts"
+    // my awesome build script in Kotlin
+    ```
+  </TabItem>
+  <TabItem label="Gradle (Groovy)">
+    ```groovy title="build.gradle"
+    // my awesome build script in Groovy
+    ```
+  </TabItem>
+  <TabItem label="Maven">
+    ```xml title="pom.xml"
+    <!-- my awesome build script in XML -->
+    ```
+  </TabItem>
+</Tabs>
+```
+
 ## Code of Conduct
 
 Contributors are expected to follow the [Community Guidelines](https://papermc.io/community/guidelines) of the PaperMC organization in all

_redirects

@@ -19,3 +19,5 @@
 /paper/dev/commands /paper/dev/command-api/basics/introduction
 /paper/dev/command-api/commands /paper/dev/command-api/basics/introduction
 /paper/dev/command-api/arguments /paper/dev/command-api/basics/arguments-and-literals
+/adventure/contributing https://github.com/PaperMC/docs/blob/main/CONTRIBUTING.md
+/adventure/version-history/adventure-platform-fabric /adventure/version-history/adventure-platform-mod

astro.config.ts

@@ -1,14 +1,18 @@
 import starlight from "@astrojs/starlight";
 import svelte from "@astrojs/svelte";
-import { pluginCollapsibleSections } from "@expressive-code/plugin-collapsible-sections";
-import { pluginLineNumbers } from "@expressive-code/plugin-line-numbers";
 import d2 from "astro-d2";
 import { defineConfig } from "astro/config";
 import starlightLinksValidator from "starlight-links-validator";
 import starlightSidebarTopics from "starlight-sidebar-topics";
 import codeConstantsPlugin from "./src/utils/remark/code_const";
 import javadocPlugin from "./src/utils/remark/javadoc";
 import {
+  LATEST_ADVENTURE_API_RELEASE,
+  LATEST_ADVENTURE_PLATFORM_MOD_RELEASE,
+  LATEST_ADVENTURE_PLATFORM_RELEASE,
+  LATEST_ADVENTURE_SUPPORTED_MC,
+  LATEST_ADVENTURE_SUPPORTED_MC_RANGE,
+  LATEST_ANSI_RELEASE,
   LATEST_FOLIA_RELEASE,
   LATEST_MC_RELEASE,
   LATEST_PAPER_RELEASE,
@@ -53,6 +57,9 @@ export default defineConfig({
           href: `https://jd.papermc.io/folia/${LATEST_FOLIA_RELEASE.split(".").slice(0, 2).join(".")}`,
         },
 
+        { icon: "github", label: "adventure:GitHub", href: "https://github.com/KyoriPowered/adventure" },
+        { icon: "seti:java", label: "adventure:Javadoc", href: "https://jd.advntr.dev" },
+
         { icon: "github", label: "waterfall:GitHub", href: "https://github.com/PaperMC/Waterfall" },
         {
           icon: "seti:java",
@@ -91,6 +98,9 @@ export default defineConfig({
       },
       plugins: [
         starlightLinksValidator({
+          exclude: [
+            "/adventure/version-history/*", // custom pages
+          ],
           errorOnInvalidHashes: false, // enable if you want to check hashes - it doesn't work with config diagrams
         }),
         starlightSidebarTopics(
@@ -358,19 +368,98 @@ export default defineConfig({
                 },
               ],
             },
+            {
+              id: "adventure",
+              label: "Adventure",
+              link: "/adventure/",
+              icon: "adventure",
+              items: [
+                "adventure/getting-started",
+                "adventure/community-libraries",
+                "adventure/faq",
+                "adventure/audiences",
+                "adventure/text",
+                {
+                  label: "Text serializers",
+                  items: [
+                    "adventure/serializer",
+                    "adventure/serializer/json",
+                    "adventure/serializer/gson",
+                    "adventure/serializer/legacy",
+                    "adventure/serializer/plain",
+                    {
+                      label: "MiniMessage",
+                      items: [
+                        "adventure/minimessage",
+                        "adventure/minimessage/format",
+                        "adventure/minimessage/api",
+                        "adventure/minimessage/dynamic-replacements",
+                        "adventure/minimessage/translator",
+                      ],
+                    },
+                    "adventure/serializer/ansi",
+                  ],
+                },
+                "adventure/bossbar",
+                "adventure/sound",
+                "adventure/titles",
+                "adventure/book",
+                "adventure/tablist",
+                "adventure/resource-pack",
+                {
+                  label: "MiniMessage",
+                  items: [
+                    "adventure/minimessage",
+                    "adventure/minimessage/format",
+                    "adventure/minimessage/api",
+                    "adventure/minimessage/dynamic-replacements",
+                    "adventure/minimessage/translator",
+                  ],
+                },
+                "adventure/localization",
+                {
+                  label: "Platforms",
+                  items: [
+                    "adventure/platform",
+                    "adventure/platform/native",
+                    "adventure/platform/bukkit",
+                    "adventure/platform/bungeecord",
+                    "adventure/platform/spongeapi",
+                    "adventure/platform/modded",
+                    "adventure/platform/fabric",
+                    "adventure/platform/neoforge",
+                    "adventure/platform/viaversion",
+                    "adventure/platform/implementing",
+                  ],
+                },
+                {
+                  label: "Version history",
+                  items: [
+                    { label: "adventure", link: "/adventure/version-history/adventure" },
+                    { label: "adventure-platform", link: "/adventure/version-history/adventure-platform" },
+                    {
+                      label: "adventure-platform-mod",
+                      link: "/adventure/version-history/adventure-platform-mod",
+                    },
+                  ],
+                },
+                {
+                  label: "Migrating to Adventure from other APIs",
+                  items: [
+                    "adventure/migration",
+                    "adventure/migration/bungeecord-chat-api",
+                    "adventure/migration/text-3.x",
+                  ],
+                },
+              ],
+            },
             {
               id: "waterfall",
               label: "Waterfall",
               link: "/waterfall/",
               icon: "waterfall",
               items: ["waterfall/getting-started", "waterfall/configuration"],
             },
-            {
-              id: "adventure",
-              label: "Adventure",
-              link: "https://docs.advntr.dev/",
-              icon: "adventure",
-            },
             {
               id: "misc",
               label: "Miscellaneous",
@@ -429,23 +518,13 @@ export default defineConfig({
                 "/velocity/dev/api",
               ],
               folia: ["/folia/admin", "/folia/admin/reference"],
+              adventure: ["/adventure/version-history"],
               waterfall: ["/waterfall"],
               misc: ["/misc", "/misc/tools"],
             },
           }
         ),
       ],
-      expressiveCode: {
-        plugins: [pluginLineNumbers(), pluginCollapsibleSections()],
-        defaultProps: {
-          showLineNumbers: false,
-          collapseStyle: "collapsible-start",
-        },
-        frames: {
-          extractFileNameFromCode: false,
-        },
-        emitExternalStylesheet: false,
-      },
     }),
     svelte(),
     d2({
@@ -482,6 +561,12 @@ export default defineConfig({
             LATEST_FOLIA_RELEASE,
             LATEST_WATERFALL_RELEASE,
             LATEST_USERDEV_RELEASE,
+            LATEST_ADVENTURE_SUPPORTED_MC,
+            LATEST_ADVENTURE_SUPPORTED_MC_RANGE,
+            LATEST_ADVENTURE_API_RELEASE,
+            LATEST_ADVENTURE_PLATFORM_RELEASE,
+            LATEST_ADVENTURE_PLATFORM_MOD_RELEASE,
+            LATEST_ANSI_RELEASE,
           },
         },
       ],

ec.config.mjs

@@ -0,0 +1,19 @@
+import { pluginCollapsibleSections } from "@expressive-code/plugin-collapsible-sections";
+import { pluginLineNumbers } from "@expressive-code/plugin-line-numbers";
+import miniMessageHighlight from "./src/utils/shiki/mm.tmLanguage.json" with { type: "json" };
+
+/** @type {import('@astrojs/starlight/expressive-code').StarlightExpressiveCodeOptions} */
+export default {
+  plugins: [pluginLineNumbers(), pluginCollapsibleSections()],
+  defaultProps: {
+    showLineNumbers: false,
+    collapseStyle: "collapsible-start",
+  },
+  frames: {
+    extractFileNameFromCode: false,
+  },
+  emitExternalStylesheet: false,
+  shiki: {
+    langs: [miniMessageHighlight],
+  },
+};

package.json

@@ -20,6 +20,7 @@
     "@fontsource/jetbrains-mono": "^5.2.8",
     "@fontsource/poppins": "^5.2.7",
     "astro": "^5.13.9",
+    "@ascorbic/feed-loader": "^1.0.4",
     "astro-d2": "^0.8.0",
     "sharp": "^0.34.4",
     "starlight-contributor-list": "^0.3.0",