feat(docs): migrate documentation site into monorepo (#5912)
This commit is contained in:
1 parent
3e464a76f2
commit
9e421c67bd
605 files changed
+26764
-219
No files matched your search
Binary file not shown.
|
After Width: | Height: | Size: 3.6 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
@@ -0,0 +1,44 @@
|
||||
---
|
||||
title: 'Minecraft Server Status'
|
||||
description: 'Displays the status of a Minecraft server.'
|
||||
hide_title: true
|
||||
---
|
||||
|
||||
import { AddingWidget } from '@site/src/components/widgets/adding';
|
||||
import { WidgetConfig } from '@site/src/components/widgets/configuration';
|
||||
import { WidgetHeader } from '@site/src/components/widgets/header';
|
||||
import { WidgetIntegrations } from '@site/src/components/widgets/integrations';
|
||||
import { IconAd } from "@tabler/icons-react";
|
||||
import TabItem from '@theme/TabItem';
|
||||
import Tabs from '@theme/Tabs';
|
||||
import { minecraftServerStatusWidget } from '.';
|
||||
|
||||
|
||||
<WidgetHeader
|
||||
widget={minecraftServerStatusWidget}
|
||||
categories={['Gaming', 'Minecraft']}
|
||||
/>
|
||||
|
||||
Shows the status and amount of players on a Minecraft server. It supports both Java and Bedrock editions, however only public servers are supported which can be reached through the used api of [api.mcsrvstat.us](https://api.mcsrvstat.us).
|
||||
|
||||
### Screenshots
|
||||
|
||||
import javaItem from './img/java.png';
|
||||
import bedrockItem from './img/bedrock.png';
|
||||
|
||||
<div className='flex gap-1'>
|
||||
<img src={javaItem} alt="minecraft-server-status java-edition" width={128 * 1.5} height={128 * 1.5} />
|
||||
<img src={bedrockItem} alt="minecraft-server-status bedrock-editon" width={128 * 1.5} height={128 * 1.5} />
|
||||
</div>
|
||||
|
||||
### Adding the widget
|
||||
|
||||
<AddingWidget />
|
||||
|
||||
### Configuration
|
||||
<WidgetConfig configuration={minecraftServerStatusWidget.configuration} />
|
||||
|
||||
### Data source
|
||||
|
||||
We use the Minecraft Server Status API to fetch the server status.
|
||||
If you need to whitelist the api, please use the following URL: `hhttps://api.mcsrvstat.us`
|
||||
@@ -0,0 +1,31 @@
|
||||
import { WidgetDefinition } from "@site/src/types";
|
||||
import { IconBrandMinecraft } from "@tabler/icons-react";
|
||||
|
||||
export const minecraftServerStatusWidget: WidgetDefinition = {
|
||||
icon: IconBrandMinecraft,
|
||||
name: "Minecraft Server Status",
|
||||
description: "Displays the status of a Minecraft server.",
|
||||
path: "../../widgets/minecraft-server-status",
|
||||
configuration: {
|
||||
items: [
|
||||
{
|
||||
name: "Title",
|
||||
description: "Title to show on top. Leave empty to show server address.",
|
||||
values: { type: "string" },
|
||||
defaultValue: "-",
|
||||
},
|
||||
{
|
||||
name: "Server address",
|
||||
description: "Public address of the Minecraft server",
|
||||
values: { type: "string" },
|
||||
defaultValue: "hypixel.net",
|
||||
},
|
||||
{
|
||||
name: "Bedrock server",
|
||||
description: "Wheter the server is a Bedrock server",
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "no",
|
||||
},
|
||||
],
|
||||
},
|
||||
};
|
||||
Reference in new issue
Block a user