Files
GeyserWebsite/docusaurus.config.ts
T

288 lines
9.7 KiB
TypeScript
Raw Normal View History

2024-01-25 22:38:57 -08:00
import { themes as prismThemes } from 'prism-react-renderer';
import type { Config } from '@docusaurus/types';
2023-11-07 19:40:55 -06:00
import type * as Preset from '@docusaurus/preset-classic';
2024-03-24 22:55:16 -07:00
import { docOgRenderer, blogOgRenderer, pageOgRenderer } from './src/renderer/ImageRenderers';
2023-11-07 19:40:55 -06:00
const config: Config = {
2024-01-29 00:04:58 -08:00
title: 'GeyserMC',
2024-02-25 00:53:46 -08:00
tagline: 'Revolutionize Your Minecraft Server',
2024-01-25 22:38:57 -08:00
favicon: 'img/favicon.ico',
2024-07-21 18:59:14 +01:00
url: 'https://geysermc.org',
2024-01-25 22:38:57 -08:00
baseUrl: '/',
2023-11-07 19:40:55 -06:00
2024-07-14 14:19:34 -07:00
organizationName: 'GeyserMC',
projectName: 'GeyserWebsite',
2023-11-07 19:40:55 -06:00
2024-01-25 22:38:57 -08:00
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
2023-11-07 19:40:55 -06:00
2024-01-25 22:38:57 -08:00
i18n: {
defaultLocale: 'en',
2024-07-14 13:51:47 -07:00
locales: ['en'],
2024-01-25 22:38:57 -08:00
},
2023-11-07 19:40:55 -06:00
2024-01-25 22:38:57 -08:00
presets: [
[
'classic',
{
docs: {
2024-03-12 15:38:42 +00:00
sidebarPath: require.resolve("./sidebars.ts"),
2024-01-25 22:38:57 -08:00
editUrl:
2024-03-25 11:29:12 +00:00
'https://github.com/GeyserMC/GeyserWebsite/tree/master/',
2023-11-07 19:55:30 -06:00
2024-07-18 10:38:53 +01:00
routeBasePath: '/wiki',
2024-03-12 00:35:02 -07:00
docItemComponent: "@theme/ApiItem",
2024-07-18 10:38:53 +01:00
path: 'wiki',
2024-01-25 22:38:57 -08:00
},
2024-03-11 23:00:24 -07:00
blog: {},
2024-01-25 22:38:57 -08:00
theme: {
2024-07-15 16:07:13 +01:00
customCss: './src/css/custom.scss',
2024-01-25 22:38:57 -08:00
},
} satisfies Preset.Options,
],
2023-11-07 19:40:55 -06:00
],
2024-03-12 00:35:02 -07:00
plugins: [
[
'docusaurus-plugin-openapi-docs',
{
id: "api",
docsPluginId: "classic",
config: {
2024-03-12 15:38:42 +00:00
'downloads.geysermc.org': {
2024-03-12 00:39:54 -07:00
specPath: "openapi/downloads.json",
2024-07-18 10:38:53 +01:00
outputDir: "wiki/api/downloads.geysermc.org",
2024-03-12 15:38:42 +00:00
sidebarOptions: {
groupPathsBy: "tag",
},
2024-03-12 00:35:02 -07:00
},
2024-03-12 15:38:42 +00:00
'api.geysermc.org': {
2024-03-12 00:39:54 -07:00
specPath: "openapi/global.json",
2024-07-18 10:38:53 +01:00
outputDir: "wiki/api/api.geysermc.org",
2024-03-12 15:38:42 +00:00
sidebarOptions: {
groupPathsBy: "tag",
},
2024-03-12 00:35:02 -07:00
}
}
},
2024-03-24 22:55:16 -07:00
],
[
'@kas-tle/docusaurus-og',
{
path: './preview-images',
imageRenderers: {
'docusaurus-plugin-content-docs': docOgRenderer,
'docusaurus-plugin-content-pages': pageOgRenderer,
'docusaurus-plugin-content-blog': blogOgRenderer,
},
},
2024-07-15 16:07:13 +01:00
],
2024-07-27 15:28:39 +01:00
'docusaurus-plugin-sass',
2024-08-31 19:31:10 +01:00
'./src/plugins/create-versions-json.ts',
'./src/plugins/create-providers-json.ts'
2024-03-12 00:35:02 -07:00
],
themes: ["docusaurus-theme-openapi-docs"],
2024-01-25 22:38:57 -08:00
themeConfig: {
2024-03-03 12:07:43 -08:00
image: 'img/site/geyser.png',
2024-01-25 22:38:57 -08:00
navbar: {
2024-01-29 00:04:58 -08:00
title: 'GeyserMC',
2024-01-25 22:38:57 -08:00
logo: {
alt: 'GeyserMC logo',
src: 'img/apple-touch-icon.png',
2023-11-07 19:40:55 -06:00
},
2024-01-25 22:38:57 -08:00
items: [
{
2024-01-29 00:04:58 -08:00
type: 'dropdown',
label: 'Wiki',
2024-03-02 23:32:57 -08:00
className: 'header-wiki-link',
2024-03-11 23:00:24 -07:00
position: 'left',
to: 'wiki/',
2024-01-29 00:04:58 -08:00
items: [
{
type: 'doc',
docId: 'geyser/index',
2024-01-29 00:04:58 -08:00
label: 'Geyser',
},
{
type: 'doc',
docId: 'floodgate/index',
2024-01-29 00:04:58 -08:00
label: 'Floodgate',
},
2024-03-12 00:35:02 -07:00
{
type: 'doc',
docId: 'api/index',
2024-03-12 00:35:02 -07:00
label: 'REST APIs',
},
2024-01-29 00:04:58 -08:00
{
type: 'doc',
docId: 'other/index',
2024-01-29 00:04:58 -08:00
label: 'Other',
},
]
2024-01-25 22:38:57 -08:00
},
2024-03-11 23:00:24 -07:00
{
2024-03-12 00:35:02 -07:00
to: 'blog',
label: 'Blog',
2024-03-11 23:00:24 -07:00
position: 'left',
className: 'header-blog-link'
},
2024-05-15 16:40:29 +01:00
{
type: 'dropdown',
label: 'Utilities',
className: 'header-utilities-link',
position: 'left',
items: [
{
to: 'utilities/dump-viewer',
label: 'Dump Viewer',
}
]
},
2024-01-25 22:38:57 -08:00
{
2024-01-29 00:04:58 -08:00
to: 'download',
2024-03-02 23:32:57 -08:00
label: 'Download',
2024-03-11 23:00:24 -07:00
position: 'left',
2024-01-29 00:04:58 -08:00
className: 'header-download-link'
2024-01-25 22:38:57 -08:00
},
{ // Name on mobile sidebar specified in custom.scss
2024-01-29 00:04:58 -08:00
href: 'https://github.com/GeyserMC/Geyser',
position: 'right',
className: 'header-github-link'
2024-01-25 22:38:57 -08:00
},
{ // Name on mobile sidebar specified in custom.scss
2024-01-29 00:04:58 -08:00
href: 'https://discord.gg/geysermc',
2024-01-25 22:38:57 -08:00
position: 'right',
2024-01-29 00:04:58 -08:00
className: 'header-discord-link'
2024-01-25 22:38:57 -08:00
},
2024-07-14 14:19:34 -07:00
// {
// type: 'localeDropdown',
// position: 'right',
// },
2024-01-25 22:38:57 -08:00
],
2023-11-07 19:40:55 -06:00
},
2024-01-25 22:38:57 -08:00
footer: {
2024-07-14 17:23:02 -07:00
logo: {
alt: 'GeyserMC logo',
src: 'img/site/geyser-text.svg',
href: '/',
width: 430,
},
copyright: `Copyright © ${new Date().getFullYear()} GeyserMC. Built with Docusaurus.<br>This website is not an official Minecraft website and is not associated with Mojang Studios or Microsoft. All product and company names are trademarks or registered trademarks of their respective holders. Use of these names does not imply any affiliation or endorsement by them.`,
2024-07-14 17:23:02 -07:00
links: [
{
title: 'Wiki',
items: [
{
label: 'Geyser',
2024-07-17 19:40:08 +01:00
to: 'wiki/geyser/setup',
2024-07-14 17:23:02 -07:00
},
{
label: 'Floodgate',
2024-07-17 19:40:08 +01:00
to: 'wiki/floodgate/setup',
2024-07-14 17:23:02 -07:00
},
{
label: 'REST APIs',
2024-07-18 10:38:53 +01:00
to: 'wiki/api/api.geysermc.org/global-api',
2024-07-14 17:23:02 -07:00
},
{
label: 'Other',
2024-07-17 19:40:08 +01:00
to: 'wiki/other/geyseroptionalpack',
2024-07-14 17:23:02 -07:00
},
],
},
{
title: 'Downloads',
items: [
{
label: 'Geyser',
to: 'download?project=geyser',
},
{
label: 'Floodgate',
to: 'download?project=floodgate',
},
{
label: 'Other',
to: 'download?project=other-projects',
}
],
},
{
title: 'Community',
items: [
{
label: 'Crowdin',
href: 'https://translate.geysermc.org/',
},
{
label: 'Discord',
href: 'https://discord.gg/geysermc',
},
{
label: 'GitHub',
href: 'https://github.com/GeyserMC/Geyser',
},
{
label: 'Reddit',
href: 'https://www.reddit.com/r/GeyserMC/',
},
{
label: 'Twitter',
2024-07-20 00:36:00 -05:00
href: 'https://twitter.com/Geyser_MC',
2024-07-14 17:23:02 -07:00
},
],
},
{
title: 'More',
items: [
{
label: 'Blog',
to: 'blog',
},
{
label: 'Donate',
href: 'https://opencollective.com/geysermc',
},
{
label: 'Global Linking',
to: 'https://link.geysermc.org/',
},
],
},
]
2023-11-07 19:40:55 -06:00
},
2024-01-25 22:38:57 -08:00
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
2024-03-25 11:29:12 +00:00
additionalLanguages: [
'bash', 'batch', 'java', 'json', // Docs
'php', 'powershell', 'csharp', 'ruby' // API examples
],
2024-01-25 22:38:57 -08:00
},
colorMode: {
defaultMode: 'dark',
disableSwitch: false,
2024-01-28 15:40:31 -08:00
respectPrefersColorScheme: false,
},
2024-03-02 23:32:57 -08:00
docs: {
sidebar: {
hideable: true,
}
},
algolia: {
appId: '0DTHI9QFCH',
2024-03-12 00:35:02 -07:00
apiKey: '3cc0567f76d2ed3ffdb4cc94f0ac9815',
indexName: 'geysermc',
contextualSearch: true,
searchPagePath: 'search',
},
2024-03-24 23:30:02 -07:00
metadata: [
2024-07-14 17:23:02 -07:00
{ name: 'theme-color', content: '#25c2a0' },
2024-03-24 23:30:02 -07:00
],
2024-01-25 22:38:57 -08:00
} satisfies Preset.ThemeConfig,
2023-11-07 19:40:55 -06:00
};
export default config;