Add more index pages, fix /wiki/ not showing anything (#16)

This commit is contained in:
chris authored and GitHub committed 2024-07-24 23:54:28 +01:00
1 parent d067acbd85
commit 932dda7edd
6 files changed
+111 -15

No files matched your search

+4 -4
View File
@@ -96,7 +96,7 @@ const config: Config = {
label: 'Wiki',
className: 'header-wiki-link',
position: 'left',
to: 'wiki/geyser/',
to: 'wiki/',
items: [
{
type: 'doc',
@@ -105,17 +105,17 @@ const config: Config = {
},
{
type: 'doc',
docId: 'floodgate/setup',
docId: 'floodgate/index',
label: 'Floodgate',
},
{
type: 'doc',
docId: 'api/api.geysermc.org/global-api',
docId: 'api/index',
label: 'REST APIs',
},
{
type: 'doc',
docId: 'other/geyseroptionalpack',
docId: 'other/index',
label: 'Other',
},
]
+7 -4
View File
@@ -13,6 +13,7 @@ import type { SidebarsConfig } from '@docusaurus/plugin-content-docs';
const sidebars: SidebarsConfig = {
// By default, Docusaurus generates a sidebar from the docs folder structure
apiSidebar: [
"api/index",
{
type: "category",
label: "api.geysermc.org",
@@ -130,14 +131,16 @@ const sidebars: SidebarsConfig = {
],
otherSidebar: [
'other/geyseroptionalpack',
'other/hurricane',
'other/index',
'other/geyserconnect',
'other/thirdpartycosmetics',
'other/geyseroptionalpack',
'other/community-geyser-projects',
'other/hurricane',
'other/hydraulic',
'other/test-server',
'other/developer-guide',
'other/discord-bot-usage',
'other/hydraulic'
'other/discord-bot-usage'
]
};
+28
View File
@@ -0,0 +1,28 @@
---
title: Overview
permalink: /api/
description: 'These REST APIs provide web endpoints to query different information.'
---
import DocCardList from '@theme/DocCardList'
# Overview of available REST APIs
Currently, there are two different Rest APIs you can use.
<DocCardList items={[
{
"type": "link",
"label": "Geyser Global API",
"description": "Provides information on players, such as xuids, skins, or linking information.",
"href": "/wiki/api/global",
"unlisted": false
},
{
"type": "link",
"label": "Downloads API",
"description": "Provides information and download links to projects on the Downloads API",
"href": "/wiki/api/downloads",
"unlisted": false
}
]} />
+42
View File
@@ -0,0 +1,42 @@
---
title: Overview of this wiki
permalink: /wiki/
description: 'This page provides an overview over all sections of the GeyserMC wiki'
---
import DocCardList from '@theme/DocCardList'
# Overview
The GeyserMC wiki offers guides on different projects. Select the one you are interested in below!
<DocCardList items={[
{
"type": "link",
"label": "Geyser",
"href": "/wiki/geyser/",
"docId": "geyser/index",
"unlisted": false
},
{
"type": "link",
"label": "Floodgate",
"href": "/wiki/floodgate/",
"docId": "floodgate/index",
"unlisted": false
},
{
"type": "link",
"label": "Other projects",
"href": "/wiki/other/",
"docId": "other/index",
"unlisted": false
},
{
"type": "link",
"label": "REST APIs",
"href": "/wiki/api/",
"docId": "api/index",
"unlisted": false
}
]} />
+30
View File
@@ -0,0 +1,30 @@
---
title: Overview
permalink: /other/
description: 'Other projects or guides not directly referring to Geyser or Floodgate.'
---
import DocCardList from '@theme/DocCardList'
import { useDocById } from '@docusaurus/theme-common/internal'
# Overview of Other projects
The "other" category provides you with information about different projects that are not Geyser or Floodgate.
This includes community projects, but also other projects by the GeyserMC team, such as Hurricane or Hydraulic.
<DocCardList items={[
'community-geyser-projects',
'hurricane',
'geyseroptionalpack',
'thirdpartycosmetics',
'hydraulic',
'geyserconnect',
].map((id) => {
const metadata = useDocById("other/" + id)
return {
type: 'link',
label: metadata.title,
href: id,
docId: 'other/' + id
}
})} />
-7
View File
@@ -1,7 +0,0 @@
---
title: Other
permalink: /other/
description: Information about other Geyser-related projects.
---
# Other