Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
ae63684
Add Adventure docs
Strokkur424 Apr 20, 2025
8a16fae
pnpm format
Strokkur424 May 14, 2025
f5d5a5b
Refactor spell checking
Strokkur424 May 14, 2025
4cb359a
Add fallback json if stuff is broken
Strokkur424 May 14, 2025
f4417ce
Try to fix compile errors
Strokkur424 May 14, 2025
6467ca3
Cleanup releases.ts
Strokkur424 May 14, 2025
30e71f3
Add more debug logging
Strokkur424 May 18, 2025
8bd7a6c
pnpm format
Strokkur424 May 19, 2025
c2d7e78
Update to be up-to-date with latest Adventure docs
Strokkur424 May 19, 2025
7bb1944
Add/improve dynamic mod version fetching
Strokkur424 May 19, 2025
4729af3
Move adventure changelogs to pages section for manual ToC creation
Strokkur424 May 19, 2025
4031595
Add prepend tag attribute
Strokkur424 May 19, 2025
d1d3499
format
Strokkur424 May 19, 2025
8ab4e5c
refactor: use GitHub releases Atom feed
zlataovce May 20, 2025
8f6e8d9
fix: oops
zlataovce May 20, 2025
0e09dce
fix: exclude custom pages from link validator
zlataovce May 20, 2025
cff8729
chore: remove Adventure docs contributing page
zlataovce May 20, 2025
28b57ab
refactor: rework social icons for Adventure links
zlataovce May 20, 2025
4af64de
refactor: build system dependency references
zlataovce Jun 1, 2025
307f7a1
refactor: rename `.mdx` files to `.md` where no MDX markup is used
zlataovce Jun 1, 2025
bbbdce1
refactor: change docs.oracle.com links to Javadoc shortcuts
zlataovce Jun 1, 2025
be4e842
refactor: style fixes, add notable index pages to sidebar
zlataovce Jun 1, 2025
8d07c1e
fix: deleted too much
zlataovce Jun 1, 2025
fd46ad3
fix: change index page names only in sidebar
zlataovce Jun 1, 2025
fc1f73f
fix: comments
zlataovce Jun 27, 2025
cbfcfe7
fix: remove automatic Adventure versioning logic
zlataovce Jun 27, 2025
e3801aa
feat: move Adventure-supported MC versions to replaceable constant
zlataovce Jun 27, 2025
b92315f
chore: move ec config to dedicated file
Strokkur424 Aug 17, 2025
708baaa
fix: directly use code blocks to avoid a nasty bug in EC
Strokkur424 Oct 3, 2025
9bdf488
chore: add slugs to all pages
Strokkur424 Oct 3, 2025
2f51847
chore: bump adventure versions
Strokkur424 Oct 3, 2025
9a4aaa6
chore: fix image style in minimessage format page
Strokkur424 Oct 3, 2025
38addf1
chore: update with latest kyori docs changes
Strokkur424 Oct 3, 2025
7f463ad
chore: apply review comments
Strokkur424 Oct 3, 2025
02f5e46
chore: address ollie's comments
Strokkur424 Oct 3, 2025
dedcc4e
chore: pnpm format
Strokkur424 Oct 3, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 41 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions _redirects
Original file line number Diff line number Diff line change
Expand Up @@ -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
123 changes: 104 additions & 19 deletions astro.config.ts
Original file line number Diff line number Diff line change
@@ -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,
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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(
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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({
Expand Down Expand Up @@ -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,
},
},
],
Expand Down
19 changes: 19 additions & 0 deletions ec.config.mjs
Original file line number Diff line number Diff line change
@@ -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],
},
};
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
Loading