Huge documentation update

This commit is contained in:
2024-12-02 12:41:26 -06:00
parent 13f2b301f1
commit 15bc449f7e
290 changed files with 80901 additions and 49342 deletions

View File

@ -3,9 +3,9 @@ import Heading from '@theme/Heading';
import styles from './styles.module.css';
type FeatureItem = {
title: string;
Svg: React.ComponentType<React.ComponentProps<'svg'>>;
description: JSX.Element;
title: string;
Svg: React.ComponentType<React.ComponentProps<'svg'>>;
description: JSX.Element;
};
const FeatureList: FeatureItem[] = [
@ -24,7 +24,8 @@ const FeatureList: FeatureItem[] = [
Svg: require('@site/static/img/sliders-solid.svg').default,
description: (
<>
Plex is designed to be customizable to fit your server's needs. Almost all messages within the plugin can be easily changed.
Plex is designed to be customizable to fit your server's needs. Almost all messages within the plugin
can be easily changed.
</>
),
},
@ -33,7 +34,8 @@ const FeatureList: FeatureItem[] = [
Svg: require('@site/static/img/dice-solid.svg').default,
description: (
<>
Plex allows you to use integrate with a permission system and "fake op" players. This allows server owners to have much more control over what is and isn't allowed.
Plex allows you to use integrate with a permission system and "fake op" players. This allows server
owners to have much more control over what is and isn't allowed.
Any Vault-compatible permission plugin will integrate with Plex and can be used instead of ranks.
</>
),
@ -43,7 +45,8 @@ const FeatureList: FeatureItem[] = [
Svg: require('@site/static/img/download-solid.svg').default,
description: (
<>
Plex features a fully modular system. You can add or remove modules based on how your server is configured. If you're using permissions,
Plex features a fully modular system. You can add or remove modules based on how your server is
configured. If you're using permissions,
you likely won't need our command blocker, but you will if you use ranks.
</>
),
@ -53,7 +56,8 @@ const FeatureList: FeatureItem[] = [
Svg: require('@site/static/img/forward-fast-solid.svg').default,
description: (
<>
We have written tools to convert your existing data from TotalFreedomMod to Plex. This will make your transition even easier so you won't
We have written tools to convert your existing data from TotalFreedomMod to Plex. This will make your
transition even easier so you won't
have to start fresh.
</>
),
@ -63,7 +67,8 @@ const FeatureList: FeatureItem[] = [
Svg: require('@site/static/img/bug-slash-solid.svg').default,
description: (
<>
Each release is tested to find bugs before you have to encounter them on your server. Plex's codebase was designed for rapid progress and
Each release is tested to find bugs before you have to encounter them on your server. Plex's codebase
was designed for rapid progress and
won't unexpectedly break.
</>
),
@ -71,29 +76,29 @@ const FeatureList: FeatureItem[] = [
];
function Feature({title, Svg, description}: FeatureItem) {
return (
<div className={clsx('col col--4')}>
<div className="text--center">
<Svg className={styles.featureSvg} role="img" />
</div>
<div className="text--center padding-horiz--md">
<Heading as="h3">{title}</Heading>
<p>{description}</p>
</div>
</div>
);
return (
<div className={clsx('col col--4')}>
<div className="text--center">
<Svg className={styles.featureSvg} role="img"/>
</div>
<div className="text--center padding-horiz--md">
<Heading as="h3">{title}</Heading>
<p>{description}</p>
</div>
</div>
);
}
export default function HomepageFeatures(): JSX.Element {
return (
<section className={styles.features}>
<div className="container">
<div className="row">
{FeatureList.map((props, idx) => (
<Feature key={idx} {...props} />
))}
</div>
</div>
</section>
);
return (
<section className={styles.features}>
<div className="container">
<div className="row">
{FeatureList.map((props, idx) => (
<Feature key={idx} {...props} />
))}
</div>
</div>
</section>
);
}

View File

@ -1,11 +1,11 @@
.features {
display: flex;
align-items: center;
padding: 3rem 0;
width: 100%;
display: flex;
align-items: center;
padding: 3rem 0;
width: 100%;
}
.featureSvg {
height: 115px;
width: 115px;
height: 115px;
width: 115px;
}

View File

@ -6,25 +6,25 @@
/* You can override the default Infima variables here. */
:root {
--ifm-color-primary: #2E86C1;
--ifm-color-primary-dark: #2874A6;
--ifm-color-primary-darker: #21618C;
--ifm-color-primary-darkest: #1B4F72;
--ifm-color-primary-light: #3498DB;
--ifm-color-primary-lighter: #5DADE2;
--ifm-color-primary-lightest: #85C1E9;
--ifm-code-font-size: 95%;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
--ifm-color-primary: #2E86C1;
--ifm-color-primary-dark: #2874A6;
--ifm-color-primary-darker: #21618C;
--ifm-color-primary-darkest: #1B4F72;
--ifm-color-primary-light: #3498DB;
--ifm-color-primary-lighter: #5DADE2;
--ifm-color-primary-lightest: #85C1E9;
--ifm-code-font-size: 95%;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
}
/* For readability concerns, you should choose a lighter palette in dark mode. */
[data-theme='dark'] {
--ifm-color-primary: #2471A3;
--ifm-color-primary-dark: #1F618D;
--ifm-color-primary-darker: #1A5276;
--ifm-color-primary-darkest: #154360;
--ifm-color-primary-light: #2980B9;
--ifm-color-primary-lighter: #5499C7;
--ifm-color-primary-lightest: #7FB3D5;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
--ifm-color-primary: #2471A3;
--ifm-color-primary-dark: #1F618D;
--ifm-color-primary-darker: #1A5276;
--ifm-color-primary-darkest: #154360;
--ifm-color-primary-light: #2980B9;
--ifm-color-primary-lighter: #5499C7;
--ifm-color-primary-lightest: #7FB3D5;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
}

View File

@ -4,20 +4,20 @@
*/
.heroBanner {
padding: 4rem 0;
text-align: center;
position: relative;
overflow: hidden;
padding: 4rem 0;
text-align: center;
position: relative;
overflow: hidden;
}
@media screen and (max-width: 996px) {
.heroBanner {
padding: 2rem;
}
.heroBanner {
padding: 2rem;
}
}
.buttons {
display: flex;
align-items: center;
justify-content: center;
display: flex;
align-items: center;
justify-content: center;
}

View File

@ -8,36 +8,36 @@ import Heading from '@theme/Heading';
import styles from './index.module.css';
function HomepageHeader() {
const {siteConfig} = useDocusaurusContext();
return (
<header className={clsx('hero hero--primary', styles.heroBanner)}>
<div className="container">
<Heading as="h1" className="hero__title">
{siteConfig.title}
</Heading>
<p className="hero__subtitle">{siteConfig.tagline}</p>
<div className={styles.buttons}>
<Link
className="button button--secondary button--lg"
to="/docs/intro">
Let's get started
</Link>
</div>
</div>
</header>
);
const {siteConfig} = useDocusaurusContext();
return (
<header className={clsx('hero hero--primary', styles.heroBanner)}>
<div className="container">
<Heading as="h1" className="hero__title">
{siteConfig.title}
</Heading>
<p className="hero__subtitle">{siteConfig.tagline}</p>
<div className={styles.buttons}>
<Link
className="button button--secondary button--lg"
to="/docs/intro">
Let's get started
</Link>
</div>
</div>
</header>
);
}
export default function Home(): JSX.Element {
const {siteConfig} = useDocusaurusContext();
return (
<Layout
title={`Home`}
description="The official website and documentation for Plex">
<HomepageHeader />
<main>
<HomepageFeatures />
</main>
</Layout>
);
const {siteConfig} = useDocusaurusContext();
return (
<Layout
title={`Home`}
description="The official website and documentation for Plex">
<HomepageHeader/>
<main>
<HomepageFeatures/>
</main>
</Layout>
);
}