Skip to content

Commit 4a4bccd

Browse files
sowelipililimutesowelipililimute
committed
Flatten the development hierarchy
This makes the content more immediately accessible and easier to browse through. Styling has also been adjusted as necessary to accomodate a flatter hierarchy of items; presenting content as a list with headers instead of a grid of cards.
1 parent af268e5 commit 4a4bccd

File tree

10 files changed

+183
-134
lines changed

10 files changed

+183
-134
lines changed

‎config/sidebar.paper.ts‎

Lines changed: 52 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ const paper: SidebarsConfig = {
66
{
77
type: "category",
88
label: "Administration",
9+
description: "Create, configure, and maintain a Paper server.",
910
collapsed: true,
1011
link: {
1112
type: "doc",
@@ -85,97 +86,84 @@ const paper: SidebarsConfig = {
8586
{
8687
type: "category",
8788
label: "Development",
89+
description:
90+
"Create plugins with the Paper API in order to extend Minecraft with custom and modified behavior.",
8891
collapsed: true,
8992
link: {
9093
type: "doc",
9194
id: "dev/README",
9295
},
9396
items: [
97+
{
98+
type: "html",
99+
value: "Getting Started",
100+
className: "sidebarTitle",
101+
defaultStyle: true,
102+
},
103+
"dev/getting-started/project-setup",
104+
"dev/getting-started/plugin-yml",
105+
"dev/getting-started/how-do-plugins-work",
106+
"dev/getting-started/paper-plugins",
107+
"dev/getting-started/userdev",
108+
{
109+
type: "html",
110+
value: "Plugin API",
111+
className: "sidebarTitle",
112+
defaultStyle: true,
113+
},
94114
{
95115
type: "category",
96-
label: "Getting started",
116+
label: "Event API",
117+
description: "Respond to and modify in-game actions",
97118
collapsed: true,
98-
link: {
99-
type: "doc",
100-
id: "dev/getting-started/README",
101-
},
102119
items: [
103-
"dev/getting-started/project-setup",
104-
"dev/getting-started/plugin-yml",
105-
"dev/getting-started/how-do-plugins-work",
106-
"dev/getting-started/paper-plugins",
107-
"dev/getting-started/userdev",
120+
"dev/api/event-api/event-listeners",
121+
"dev/api/event-api/custom-events",
122+
"dev/api/event-api/handler-lists",
123+
"dev/api/event-api/chat-event",
108124
],
109125
},
110126
{
111127
type: "category",
112-
label: "API",
128+
label: "Entity API",
129+
description: "Manipulate mobs and other entities",
113130
collapsed: true,
114-
link: {
115-
type: "doc",
116-
id: "dev/api/README",
117-
},
118-
items: [
119-
{
120-
type: "category",
121-
label: "Event API",
122-
collapsed: true,
123-
items: [
124-
"dev/api/event-api/event-listeners",
125-
"dev/api/event-api/custom-events",
126-
"dev/api/event-api/handler-lists",
127-
"dev/api/event-api/chat-event",
128-
],
129-
},
130-
{
131-
type: "category",
132-
label: "Entity API",
133-
collapsed: true,
134-
items: ["dev/api/entity-api/entity-teleport", "dev/api/entity-api/display-entities"],
135-
},
136-
{
137-
type: "category",
138-
label: "Component API (Adventure)",
139-
collapsed: true,
140-
items: [
141-
"dev/api/component-api/intro",
142-
"dev/api/component-api/i18n",
143-
"dev/api/component-api/audiences",
144-
],
145-
},
146-
"dev/api/pdc",
147-
"dev/api/custom-inventory-holder",
148-
"dev/api/commands",
149-
"dev/api/scheduler",
150-
"dev/api/plugin-messaging",
151-
"dev/api/plugin-configs",
152-
"dev/api/lifecycle",
153-
"dev/api/registries",
154-
"dev/api/recipes",
155-
"dev/api/folia-support",
156-
"dev/api/roadmap",
157-
],
131+
items: ["dev/api/entity-api/entity-teleport", "dev/api/entity-api/display-entities"],
158132
},
159133
{
160134
type: "category",
161-
label: "Miscellaneous",
135+
label: "Component API (Adventure)",
136+
description: "Work with Minecraft's chat components",
162137
collapsed: true,
163-
link: {
164-
type: "doc",
165-
id: "dev/misc/README",
166-
},
167138
items: [
168-
"dev/misc/reading-stacktraces",
169-
"dev/misc/debugging",
170-
"dev/misc/databases",
171-
"dev/misc/internal-code",
139+
"dev/api/component-api/intro",
140+
"dev/api/component-api/i18n",
141+
"dev/api/component-api/audiences",
172142
],
173143
},
144+
"dev/api/pdc",
145+
"dev/api/custom-inventory-holder",
146+
"dev/api/scheduler",
147+
"dev/api/plugin-messaging",
148+
"dev/api/plugin-configs",
149+
"dev/api/folia-support",
150+
"dev/api/roadmap",
151+
{
152+
type: "html",
153+
value: "Miscellaneous",
154+
className: "sidebarTitle",
155+
defaultStyle: true,
156+
},
157+
"dev/misc/reading-stacktraces",
158+
"dev/misc/debugging",
159+
"dev/misc/databases",
160+
"dev/misc/internal-code",
174161
],
175162
},
176163
{
177164
type: "category",
178165
label: "Contributing",
166+
description: "Contribute code changes to the Paper server.",
179167
collapsed: true,
180168
link: {
181169
type: "doc",

‎docs/paper/README.mdx‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import DocCardList from "@theme/DocCardList";
22

3-
# Welcome to the Paper Docs
3+
# Paper
44

55
Paper is a high performance fork of Spigot that aims to fix gameplay and
66
mechanic inconsistencies as well as to improve performance. Paper contains numerous features, bug
@@ -14,17 +14,20 @@ fixes, exploit preventions and major performance improvements not found in Spigo
1414
"label": "Administration",
1515
"href": "/paper/admin",
1616
"customEmoji": "mdi:account-cog",
17+
"description": "Create, configure, and maintain a Paper server.",
1718
},
1819
{
1920
"type": "link",
2021
"label": "Development",
2122
"href": "/paper/dev",
2223
"customEmoji": "mdi:code-braces",
24+
"description": "Create plugins with the Paper API in order to extend Minecraft with custom and modified behavior.",
2325
},
2426
{
2527
"type": "link",
2628
"label": "Contributing",
2729
"href": "/paper/contributing",
2830
"customEmoji": "mdi:comment-edit",
31+
"description": "Contribute code changes to the Paper server.",
2932
},
3033
]}/>

‎docs/paper/dev/README.mdx‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
import DocCardList from "@theme/DocCardList";
22
import { useCurrentSidebarCategory } from "@docusaurus/theme-common";
33

4-
# Development Guide
4+
# Paper Development
55

6-
Welcome to the Paper development guide! This guide includes information and tutorials for developers
7-
on how to create and expand on Paper plugins.
6+
Create plugins with the Paper API in order to extend Minecraft with custom and modified behavior.
87

98
---
109

‎docs/paper/dev/api/README.mdx‎

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎docs/paper/dev/getting-started/README.mdx‎

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎docs/paper/dev/misc/README.mdx‎

Lines changed: 0 additions & 10 deletions
This file was deleted.

‎src/css/custom.css‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,35 @@ html[data-theme="dark"] {
4646
--eol-message-background-color: rgb(92, 15, 18);
4747
}
4848

49+
.theme-doc-sidebar-item-link > a::before,
50+
.theme-doc-sidebar-item-category > div > a::before {
51+
margin-right: 0.3rem;
52+
height: 24px;
53+
width: 24px;
54+
}
55+
56+
.theme-doc-sidebar-item-link > a::before {
57+
content: url(data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHBhdGggZmlsbD0iYmxhY2siIGQ9Ik0xNCAySDZhMiAyIDAgMCAwLTIgMnYxNmEyIDIgMCAwIDAgMiAyaDEyYTIgMiAwIDAgMCAyLTJWOHptNCAxOEg2VjRoN3Y1aDV6Ii8+PC9zdmc+);
58+
}
59+
60+
.theme-doc-sidebar-item-category > div > a::before {
61+
content: url(data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHBhdGggZmlsbD0iYmxhY2siIGQ9Ik03IDVoMTR2Mkg3em0wIDh2LTJoMTR2MnpNNCA0LjVBMS41IDEuNSAwIDAgMSA1LjUgNkExLjUgMS41IDAgMCAxIDQgNy41QTEuNSAxLjUgMCAwIDEgMi41IDZBMS41IDEuNSAwIDAgMSA0IDQuNW0wIDZBMS41IDEuNSAwIDAgMSA1LjUgMTJBMS41IDEuNSAwIDAgMSA0IDEzLjVBMS41IDEuNSAwIDAgMSAyLjUgMTJBMS41IDEuNSAwIDAgMSA0IDEwLjVNNyAxOXYtMmgxNHYyem0tMy0yLjVBMS41IDEuNSAwIDAgMSA1LjUgMThBMS41IDEuNSAwIDAgMSA0IDE5LjVBMS41IDEuNSAwIDAgMSAyLjUgMThBMS41IDEuNSAwIDAgMSA0IDE2LjUiLz48L3N2Zz4=);
62+
}
63+
64+
@media (prefers-color-scheme: dark) {
65+
.theme-doc-sidebar-item-link > a::before {
66+
content: url(data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHBhdGggZmlsbD0id2hpdGUiIGQ9Ik0xNCAySDZhMiAyIDAgMCAwLTIgMnYxNmEyIDIgMCAwIDAgMiAyaDEyYTIgMiAwIDAgMCAyLTJWOHptNCAxOEg2VjRoN3Y1aDV6Ii8+PC9zdmc+);
67+
}
68+
69+
.theme-doc-sidebar-item-category > div > a::before {
70+
content: url(data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHBhdGggZmlsbD0id2hpdGUiIGQ9Ik03IDVoMTR2Mkg3em0wIDh2LTJoMTR2MnpNNCA0LjVBMS41IDEuNSAwIDAgMSA1LjUgNkExLjUgMS41IDAgMCAxIDQgNy41QTEuNSAxLjUgMCAwIDEgMi41IDZBMS41IDEuNSAwIDAgMSA0IDQuNW0wIDZBMS41IDEuNSAwIDAgMSA1LjUgMTJBMS41IDEuNSAwIDAgMSA0IDEzLjVBMS41IDEuNSAwIDAgMSAyLjUgMTJBMS41IDEuNSAwIDAgMSA0IDEwLjVNNyAxOXYtMmgxNHYyem0tMy0yLjVBMS41IDEuNSAwIDAgMSA1LjUgMThBMS41IDEuNSAwIDAgMSA0IDE5LjVBMS41IDEuNSAwIDAgMSAyLjUgMThBMS41IDEuNSAwIDAgMSA0IDE2LjUiLz48L3N2Zz4=);
71+
}
72+
}
73+
74+
.theme-doc-sidebar-menu > li:first-child > a::before {
75+
display: none;
76+
}
77+
4978
.eol-message {
5079
width: 100%;
5180
min-height: 5rem;
@@ -64,6 +93,11 @@ html[data-theme="dark"] {
6493
margin: 0;
6594
}
6695

96+
.sidebarTitle {
97+
font-size: 0.8rem;
98+
font-weight: bold;
99+
}
100+
67101
.button.button--secondary {
68102
color: #f6f7f8;
69103
}

0 commit comments

Comments
 (0)