Skip to content

Commit 9d21523

Browse files
olijeffers0nolijeffers0n
authored
fix: rearrange dir structure and naming of components (#344)
1 parent 704d5bd commit 9d21523

15 files changed

+70
-66
lines changed

‎config-specs/waterfall/waterfall-config.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
use_netty_dns_resolver:
2+
default: "true"
3+
description: >-
4+
Sets whether Netty''s async DNS resolver is used for account authentication.
5+
disable_modern_tab_limiter:
6+
default: "true"
7+
description: >-
8+
Disables the tab completion limit for 1.13+ clients.
9+
log_initial_handler_connections:
10+
default: "true"
11+
description: >-
12+
Sets whether to log InitialHandler connections.
13+
throttling:
14+
default: "1000"
15+
description: >-
16+
How often tab-complete packets can be sent in milliseconds.
17+
game_version:
18+
default: ""
19+
description: >-
20+
The supported versions displayed to the client. Default is a comma
21+
separated list of supported versions. For example 1.8.x, 1.9.x, 1.10.x
22+
disable_tab_list_rewrite:
23+
default: "true"
24+
description: >-
25+
This setting disables tablist rewriting, which may resolve issues
26+
setting player profiles when Waterfall is in offline mode.
27+
disable_entity_metadata_rewrite:
28+
default: "false"
29+
description: >-
30+
This setting disables entity metadata rewriting in favor of sending
31+
a join packet to the client. It offers a more robust solution for modded environments
32+
but can cause plugins to break.
33+
plugin_channel_name_limit:
34+
default: "128"
35+
description: >-
36+
The maximum channel identifier length. May be useful for certain broken mods.
37+
registered_plugin_channels_limit:
38+
default: "128"
39+
description: >-
40+
The maximum number of registered plugin channels for a connection.
41+
Used by mods and some plugins. May be useful to fix certain broken modpacks.

‎docs/paper/admin/reference/configuration/README.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ slug: /reference/configuration
44

55
# Paper Configuration
66

7-
import ConfigurationStructureDiagram from '@site/src/components/ConfigurationStructureDiagram';
7+
import ConfigurationStructureDiagram from '@site/src/components/config/ConfigurationStructureDiagram';
88

99
---
1010

‎docs/paper/admin/reference/configuration/bukkit-commands-configuration.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ slug: /reference/bukkit-commands-configuration
55
# Bukkit Commands Configuration
66

77
import React from 'react';
8-
import Config from '@site/src/components/Config';
8+
import ConfigDocBlock from '@site/src/components/config/ConfigDocBlock';
99
import BukkitCommandsSpec from '!!raw-loader!@site/config-specs/paper/commands.yml';
1010

1111
:::info
@@ -24,4 +24,4 @@ The aliases defined in this legacy file do not support modern features
2424

2525
:::
2626

27-
<Config data={BukkitCommandsSpec}/>
27+
<ConfigDocBlock data={BukkitCommandsSpec}/>

‎docs/paper/admin/reference/configuration/bukkit-configuration.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: An explanation of Bukkit's configuration file.
66
# Bukkit Configuration
77

88
import React from 'react';
9-
import Config from '@site/src/components/Config';
9+
import ConfigDocBlock from '@site/src/components/config/ConfigDocBlock';
1010
import BukkitConfigSpec from '!!raw-loader!@site/config-specs/paper/bukkit.yml';
1111

1212
:::info
@@ -17,4 +17,4 @@ Click on a leaf node to view the description for that setting.
1717

1818
:::
1919

20-
<Config data={BukkitConfigSpec}/>
20+
<ConfigDocBlock data={BukkitConfigSpec}/>

‎docs/paper/admin/reference/configuration/global-configuration.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: An explanation of Paper's global configuration file.
66
# Global Configuration
77

88
import React from 'react';
9-
import Config from '@site/src/components/Config';
9+
import ConfigDocBlock from '@site/src/components/config/ConfigDocBlock';
1010
import GlobalConfigSpec from '!!raw-loader!@site/config-specs/paper/paper-global.yml';
1111

1212
:::info
@@ -17,4 +17,4 @@ Click on a leaf node to view the description for that setting.
1717

1818
:::
1919

20-
<Config data={GlobalConfigSpec}/>
20+
<ConfigDocBlock data={GlobalConfigSpec}/>

‎docs/paper/admin/reference/configuration/server-properties.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: An explanation of Minecraft's server.properties file.
66
# Server Properties
77

88
import React from 'react';
9-
import Config from '@site/src/components/Config';
9+
import ConfigDocBlock from '@site/src/components/config/ConfigDocBlock';
1010
import ServerPropertiesSpec from '!!raw-loader!@site/config-specs/paper/server-properties.yml';
1111

1212
:::info
@@ -17,5 +17,5 @@ Click on a property to learn more about it.
1717

1818
:::
1919

20-
<Config data={ServerPropertiesSpec} separator={"="} defaultValue={""}/>
20+
<ConfigDocBlock data={ServerPropertiesSpec} separator={"="} defaultValue={""}/>
2121

‎docs/paper/admin/reference/configuration/spigot-configuration.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: An explanation of Spigot's configuration file.
66
# Spigot Configuration
77

88
import React from 'react';
9-
import Config from '@site/src/components/Config';
9+
import ConfigDocBlock from '@site/src/components/config/ConfigDocBlock';
1010
import SpigotConfigSpec from '!!raw-loader!@site/config-specs/paper/spigot.yml';
1111

1212
:::info
@@ -23,4 +23,4 @@ To override a per-world option, create a new key under `world-settings` with the
2323

2424
:::
2525

26-
<Config data={SpigotConfigSpec}/>
26+
<ConfigDocBlock data={SpigotConfigSpec}/>

‎docs/paper/admin/reference/configuration/world-configuration.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: An explanation of Paper's world configuration file.
66
# World Configuration
77

88
import React from 'react';
9-
import Config from '@site/src/components/Config';
9+
import ConfigDocBlock from '@site/src/components/config/ConfigDocBlock';
1010
import WorldConfigSpec from '!!raw-loader!@site/config-specs/paper/paper-world-defaults.yml';
1111

1212
:::info
@@ -17,4 +17,4 @@ Click on a leaf node to view the description for that setting.
1717

1818
:::
1919

20-
<Config data={WorldConfigSpec}/>
20+
<ConfigDocBlock data={WorldConfigSpec}/>

‎docs/waterfall/configuration.mdx

Lines changed: 3 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ eol_message: We recommend you transition to [Velocity](https://papermc.io/softwa
66
---
77

88
import React from 'react';
9-
import Config from '@site/src/components/Config';
9+
import ConfigDocBlock from '@site/src/components/config/ConfigDocBlock';
10+
import WaterfallConfigSpec from '!!raw-loader!@site/config-specs/waterfall/waterfall-config.yml';
1011

1112
# Configuration
1213

@@ -24,40 +25,4 @@ Click on a leaf node to view the description for that setting.
2425

2526
:::
2627

27-
<Config
28-
data={`
29-
use_netty_dns_resolver:
30-
default: 'true'
31-
description: 'Sets whether Netty''s async DNS resolver is used for account authentication. '
32-
disable_modern_tab_limiter:
33-
default: 'true'
34-
description: 'Disables the tab completion limit for 1.13+ clients. '
35-
log_initial_handler_connections:
36-
default: 'true'
37-
description: 'Sets whether to log InitialHandler connections. '
38-
throttling:
39-
default: '1000'
40-
description: 'How often tab-complete packets can be sent in milliseconds. '
41-
game_version:
42-
default: ''
43-
description: 'The supported versions displayed to the client. Default is a comma
44-
separated list of supported versions. For example 1.8.x, 1.9.x, 1.10.x '
45-
disable_tab_list_rewrite:
46-
default: 'true'
47-
description: 'This setting disables tablist rewriting, which may resolve issues
48-
setting player profiles when Waterfall is in offline mode. '
49-
disable_entity_metadata_rewrite:
50-
default: 'false'
51-
description: 'This setting disables entity metadata rewriting in favor of sending
52-
a join packet to the client. It offers a more robust solution for modded environments
53-
but can cause plugins to break. '
54-
plugin_channel_name_limit:
55-
default: '128'
56-
description: 'The maximum channel identifier length. May be useful for certain broken
57-
mods. '
58-
registered_plugin_channels_limit:
59-
default: '128'
60-
description: The maximum number of registered plugin channels for a connection.
61-
Used by mods and some plugins. May be useful to fix certain broken modpacks.
62-
`}
63-
/>
28+
<ConfigDocBlock data={WaterfallConfigSpec} />

‎src/components/Config.tsx renamed to ‎src/components/config/ConfigDocBlock.tsx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import React, { useState, useEffect, useRef } from "react";
22
import ReactMarkdown from "react-markdown";
33
import style from "@site/src/css/markdown-styles.module.css";
44
import yaml from "js-yaml";
5-
import VersionFormattedCode from "./VersionFormattedCode";
5+
import VersionFormattedCode from "../versioning/VersionFormattedCode";
66
import Link from "@docusaurus/Link";
77
import useBrokenLinks from "@docusaurus/core/lib/client/exports/useBrokenLinks";
88
import Admonition from "@theme/Admonition";
@@ -277,12 +277,12 @@ const YamlTreeNode = ({
277277
};
278278

279279
const renderYamlData = (
280-
data,
281-
parentKey,
280+
data: unknown,
281+
parentKey: string,
282282
root = false,
283-
separator,
284-
showAllDescriptions,
285-
defaultValue
283+
separator: string,
284+
showAllDescriptions: boolean,
285+
defaultValue: string
286286
) => {
287287
const renderedNodes: JSX.Element[] = [];
288288

0 commit comments

Comments
 (0)