Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Flatten the Paper development hierarchy #359

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Flatten the Paper development hierarchy #359

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
de15a07
Flatten the development hierarchy
pontaoski Apr 21, 2024
f83f1b0
Merge branch 'main' into fork/pontaoski/work/jblackquill/better-listings
olijeffers0n Dec 28, 2024
c830a3b
Fix merge
olijeffers0n Dec 28, 2024
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
124 changes: 55 additions & 69 deletions config/sidebar.paper.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ const paper: SidebarsConfig = {
{
type: "category",
label: "Administration",
description: "Create, configure, and maintain a Paper server.",
collapsed: true,
link: {
type: "doc",
Expand Down Expand Up @@ -85,102 +86,87 @@ const paper: SidebarsConfig = {
{
type: "category",
label: "Development",
description:
"Create plugins with the Paper API in order to extend Minecraft with custom and modified behavior.",
collapsed: true,
link: {
type: "doc",
id: "dev/README",
},
items: [
{
type: "html",
value: "Getting Started",
className: "sidebarTitle",
defaultStyle: true,
},
"dev/getting-started/project-setup",
"dev/getting-started/plugin-yml",
"dev/getting-started/how-do-plugins-work",
"dev/getting-started/paper-plugins",
"dev/getting-started/userdev",
{
type: "html",
value: "Plugin API",
className: "sidebarTitle",
defaultStyle: true,
},
{
type: "category",
label: "Getting started",
label: "Event API",
description: "Respond to and modify in-game actions",
collapsed: true,
link: {
type: "doc",
id: "dev/getting-started/README",
},
items: [
"dev/getting-started/project-setup",
"dev/getting-started/plugin-yml",
"dev/getting-started/how-do-plugins-work",
"dev/getting-started/paper-plugins",
"dev/getting-started/userdev",
"dev/api/event-api/event-listeners",
"dev/api/event-api/custom-events",
"dev/api/event-api/handler-lists",
"dev/api/event-api/chat-event",
],
},
{
type: "category",
label: "API",
label: "Entity API",
description: "Manipulate mobs and other entities",
collapsed: true,
link: {
type: "doc",
id: "dev/api/README",
},
items: [
{
type: "category",
label: "Event API",
collapsed: true,
items: [
"dev/api/event-api/event-listeners",
"dev/api/event-api/custom-events",
"dev/api/event-api/handler-lists",
"dev/api/event-api/chat-event",
],
},
{
type: "category",
label: "Brigadier Command API",
collapsed: true,
items: ["dev/api/command-api/commands", "dev/api/command-api/arguments"],
},
{
type: "category",
label: "Entity API",
collapsed: true,
items: ["dev/api/entity-api/entity-teleport", "dev/api/entity-api/display-entities"],
},
{
type: "category",
label: "Component API (Adventure)",
collapsed: true,
items: [
"dev/api/component-api/intro",
"dev/api/component-api/i18n",
"dev/api/component-api/audiences",
],
},
"dev/api/pdc",
"dev/api/custom-inventory-holder",
"dev/api/scheduler",
"dev/api/plugin-messaging",
"dev/api/plugin-configs",
"dev/api/lifecycle",
"dev/api/registries",
"dev/api/recipes",
"dev/api/folia-support",
"dev/api/roadmap",
],
items: ["dev/api/entity-api/entity-teleport", "dev/api/entity-api/display-entities"],
},
{
type: "category",
label: "Miscellaneous",
label: "Component API (Adventure)",
description: "Work with Minecraft's chat components",
collapsed: true,
link: {
type: "doc",
id: "dev/misc/README",
},
items: [
"dev/misc/reading-stacktraces",
"dev/misc/debugging",
"dev/misc/databases",
"dev/misc/internal-code",
"dev/api/component-api/intro",
"dev/api/component-api/i18n",
"dev/api/component-api/audiences",
],
},
"dev/api/pdc",
"dev/api/custom-inventory-holder",
"dev/api/scheduler",
"dev/api/plugin-messaging",
"dev/api/plugin-configs",
"dev/api/lifecycle",
"dev/api/registries",
"dev/api/recipes",
"dev/api/folia-support",
"dev/api/roadmap",
{
type: "html",
value: "Miscellaneous",
className: "sidebarTitle",
defaultStyle: true,
},
"dev/misc/reading-stacktraces",
"dev/misc/debugging",
"dev/misc/databases",
"dev/misc/internal-code",
],
},
{
type: "category",
label: "Contributing",
description: "Contribute code changes to the Paper server.",
collapsed: true,
link: {
type: "doc",
Expand Down
5 changes: 4 additions & 1 deletion docs/paper/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import DocCardList from "@theme/DocCardList";

# Welcome to the Paper Docs
# Paper

Paper is a high performance fork of Spigot that aims to fix gameplay and
mechanic inconsistencies as well as to improve performance. Paper contains numerous features, bug
Expand All @@ -14,17 +14,20 @@ fixes, exploit preventions and major performance improvements not found in Spigo
"label": "Administration",
"href": "/paper/admin",
"customEmoji": "mdi:account-cog",
"description": "Create, configure, and maintain a Paper server.",
},
{
"type": "link",
"label": "Development",
"href": "/paper/dev",
"customEmoji": "mdi:code-braces",
"description": "Create plugins with the Paper API in order to extend Minecraft with custom and modified behavior.",
},
{
"type": "link",
"label": "Contributing",
"href": "/paper/contributing",
"customEmoji": "mdi:comment-edit",
"description": "Contribute code changes to the Paper server.",
},
]}/>
5 changes: 2 additions & 3 deletions docs/paper/dev/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
import DocCardList from "@theme/DocCardList";
import { useCurrentSidebarCategory } from "@docusaurus/theme-common";

# Development Guide
# Paper Development

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

---

Expand Down
11 changes: 0 additions & 11 deletions docs/paper/dev/api/README.mdx
View file
Open in desktop
pontaoski marked this conversation as resolved.
Show resolved Hide resolved

This file was deleted.

11 changes: 0 additions & 11 deletions docs/paper/dev/getting-started/README.mdx
View file
Open in desktop

This file was deleted.

10 changes: 0 additions & 10 deletions docs/paper/dev/misc/README.mdx
View file
Open in desktop

This file was deleted.

34 changes: 34 additions & 0 deletions src/css/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,35 @@ html[data-theme="dark"] {
--eol-message-background-color: rgb(92, 15, 18);
}

.theme-doc-sidebar-item-link > a::before,
.theme-doc-sidebar-item-category > div > a::before {
margin-right: 0.3rem;
height: 24px;
width: 24px;
}

.theme-doc-sidebar-item-link > a::before {
content: url(data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHBhdGggZmlsbD0iYmxhY2siIGQ9Ik0xNCAySDZhMiAyIDAgMCAwLTIgMnYxNmEyIDIgMCAwIDAgMiAyaDEyYTIgMiAwIDAgMCAyLTJWOHptNCAxOEg2VjRoN3Y1aDV6Ii8+PC9zdmc+);
}

.theme-doc-sidebar-item-category > div > a::before {
content: url(data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHBhdGggZmlsbD0iYmxhY2siIGQ9Ik03IDVoMTR2Mkg3em0wIDh2LTJoMTR2MnpNNCA0LjVBMS41IDEuNSAwIDAgMSA1LjUgNkExLjUgMS41IDAgMCAxIDQgNy41QTEuNSAxLjUgMCAwIDEgMi41IDZBMS41IDEuNSAwIDAgMSA0IDQuNW0wIDZBMS41IDEuNSAwIDAgMSA1LjUgMTJBMS41IDEuNSAwIDAgMSA0IDEzLjVBMS41IDEuNSAwIDAgMSAyLjUgMTJBMS41IDEuNSAwIDAgMSA0IDEwLjVNNyAxOXYtMmgxNHYyem0tMy0yLjVBMS41IDEuNSAwIDAgMSA1LjUgMThBMS41IDEuNSAwIDAgMSA0IDE5LjVBMS41IDEuNSAwIDAgMSAyLjUgMThBMS41IDEuNSAwIDAgMSA0IDE2LjUiLz48L3N2Zz4=);
}

@media (prefers-color-scheme: dark) {
.theme-doc-sidebar-item-link > a::before {
content: url(data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHBhdGggZmlsbD0id2hpdGUiIGQ9Ik0xNCAySDZhMiAyIDAgMCAwLTIgMnYxNmEyIDIgMCAwIDAgMiAyaDEyYTIgMiAwIDAgMCAyLTJWOHptNCAxOEg2VjRoN3Y1aDV6Ii8+PC9zdmc+);
}

.theme-doc-sidebar-item-category > div > a::before {
content: url(data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHBhdGggZmlsbD0id2hpdGUiIGQ9Ik03IDVoMTR2Mkg3em0wIDh2LTJoMTR2MnpNNCA0LjVBMS41IDEuNSAwIDAgMSA1LjUgNkExLjUgMS41IDAgMCAxIDQgNy41QTEuNSAxLjUgMCAwIDEgMi41IDZBMS41IDEuNSAwIDAgMSA0IDQuNW0wIDZBMS41IDEuNSAwIDAgMSA1LjUgMTJBMS41IDEuNSAwIDAgMSA0IDEzLjVBMS41IDEuNSAwIDAgMSAyLjUgMTJBMS41IDEuNSAwIDAgMSA0IDEwLjVNNyAxOXYtMmgxNHYyem0tMy0yLjVBMS41IDEuNSAwIDAgMSA1LjUgMThBMS41IDEuNSAwIDAgMSA0IDE5LjVBMS41IDEuNSAwIDAgMSAyLjUgMThBMS41IDEuNSAwIDAgMSA0IDE2LjUiLz48L3N2Zz4=);
}
}

.theme-doc-sidebar-menu > li:first-child > a::before {
display: none;
}

.eol-message {
width: 100%;
min-height: 5rem;
Expand All @@ -66,6 +95,11 @@ html[data-theme="dark"] {
margin: 0;
}

.sidebarTitle {
font-size: 0.8rem;
font-weight: bold;
}

.button.button--secondary {
color: #f6f7f8;
}
Expand Down
Loading
Loading