Skip to content

Commit

Permalink
phase one of improving content labels
Browse files Browse the repository at this point in the history
  • Loading branch information
ukdaaan committed Dec 2, 2023
1 parent 53393ab commit 07bc967
Show file tree
Hide file tree
Showing 34 changed files with 892 additions and 560 deletions.
214 changes: 128 additions & 86 deletions .astro/types.d.ts

Large diffs are not rendered by default.

103 changes: 54 additions & 49 deletions astro.config.mjs
Original file line number Diff line number Diff line change
@@ -1,54 +1,59 @@
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';
import vue from "@astrojs/vue";

import tailwind from "@astrojs/tailwind";

// https://astro.build/config
export default defineConfig({
site: 'https://www.setup.md',
trailingSlash: "never",
integrations: [
starlight({
title: 'setup.md',
editLink: {
baseUrl: 'https://github.com/setupmd/docs/edit/v3',
},
social: {
discord: 'https://link.setup.md/discord',
github: 'https://link.setup.md/repo',
patreon: 'https://link.setup.md/patreon'
},
sidebar: [
{
label: 'Project Information',
autogenerate: { directory: '/information/' },
collapsed: false,
},
{
label: 'Enhancements',
autogenerate: { directory: '/enhancements/' },
collapsed: true,
},
{
label: 'Hosting Tips',
autogenerate: { directory: '/hosting/' },
collapsed: true,
},
{
label: 'Server Tools',
autogenerate: { directory: '/tools/' },
collapsed: true,
},
{
label: 'Server Troubleshooting',
autogenerate: { directory: '/troubleshooting/' },
collapsed: true,
},
{
label: 'Guides',
autogenerate: { directory: '/guides/' },
collapsed: true,
},
],
lastUpdated: true,
}),
],
});
site: 'https://www.setup.md',
trailingSlash: "never",
integrations: [starlight({
title: 'setup.md',
editLink: {
baseUrl: 'https://github.com/setupmd/docs/edit/v3'
},
social: {
discord: 'https://link.setup.md/discord',
github: 'https://link.setup.md/repo',
patreon: 'https://link.setup.md/patreon'
},
sidebar: [{
label: 'Project Information',
autogenerate: {
directory: '/information/'
},
collapsed: false
}, {
label: 'Enhancements',
autogenerate: {
directory: '/enhancements/'
},
collapsed: true
}, {
label: 'Hosting Tips',
autogenerate: {
directory: '/hosting/'
},
collapsed: true
}, {
label: 'Server Tools',
autogenerate: {
directory: '/tools/'
},
collapsed: true
}, {
label: 'Server Troubleshooting',
autogenerate: {
directory: '/troubleshooting/'
},
collapsed: true
}, {
label: 'Guides',
autogenerate: {
directory: '/guides/'
},
collapsed: true
}]
}), vue(), tailwind()]
});
9 changes: 7 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@setupmd/docs",
"type": "module",
"version": "3.0.0.b1",
"version": "3.1.1",
"private": true,
"scripts": {
"dev": "astro dev",
Expand All @@ -12,7 +12,12 @@
},
"dependencies": {
"@astrojs/starlight": "^0.11.2",
"@astrojs/tailwind": "^5.0.2",
"@astrojs/vue": "^3.0.4",
"@vitejs/plugin-vue": "^4.5.1",
"astro": "^3.2.3",
"sharp": "^0.32.5"
"sharp": "^0.32.5",
"tailwindcss": "^3.3.5",
"vue": "^3.3.9"
}
}
32 changes: 32 additions & 0 deletions src/components/MainStatusPill.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<template>
<span class="px-3 py-1 rounded-xl" :class="classes"><slot></slot></span>
</template>

<script>
export default {
props: {
info: {
type: Boolean,
},
success: {
type: Boolean,
},
warning: {
type: Boolean,
},
error: {
type: Boolean,
},
},
computed: {
classes() {
return {
"text-green-500 bg-green-50": this.success,
"text-blue-500 bg-blue-50": this.info,
"text-yellow-600 bg-yellow-50": this.warning,
"text-red-500 bg-red-50": this.error,
};
},
},
};
</script>
64 changes: 61 additions & 3 deletions src/content/docs/about.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,65 @@
---
title: About setup.md
title: About Us
description: We're an administration wiki for Minecraft server administrators who are looking to enhance their server experience.
template: splash
hero:
tagline: Learn about the project and how you can help make it even better!
---

We're building the ultimate Minecraft documentation project and if you're interested in making things even better this is the page for you.

This page will be split up into three sections to help you get about:

<ul class="pl-5 list-disc">
<li>New Ideas</li>
<li>New Content</li>
<li>Improving Content</li>
</ul>

:::caution

If you don't already have a Github account you will be required to make one before proceeding, you can create one at https://github.com/signup.

:::

### Submitting Ideas

If you're an administrator looking for docs that we don't currently have information on then this is probably the section for you, it will explain how to raise a new Github issue with the information required for us to get the ball rolling with your request.

<ul class="pl-5 list-disc">
<li>Head on over to the [setup.md Github repository](https://link.setup.md/repo)</li>
<li>In the menu bar at the top select 'Issues'</li>
<li>Select 'New Issue'</li>
<li>Select 'Feature Request'</li>
<li>Complete the required sections on the provided form</li>
</ul>

Ensure you fill out the form with as much information as you can as this will help us build better documentation

---

### Writing Content

If you're interested in writing content / migrating your own doc environment over to our wiki a Github PR is your best option. Please also ensure you have followed our [styling guide](https://contribute.setup.md) to ensure your PR doesn't get rejected for lack of continuity.

#### Single Articles

If you're going to write a single article you can do so with the following steps, before you consider uploading a document please ensure you are using a template from our [sister github repository](https://github.com/setupmd/templates/tree/main/Docs).

<ul class="pl-5 list-disc">
<li>Head on over to the [setup.md Github repository](https://link.setup.md/pr)</li>
<li>In the menu bar at the top select 'Pull Requests'</li>
<li>Select 'New Pull Request'</li>
<li>Select the branch of your forked repo that you wish to commit as a PR</li>
<li>Select 'View Pull Request'</li>
</ul>

The setup.md contributors will then verify the PR is good and will approve your content.

#### Migrating Wikis

If you already use docusaurus for your own project, adding your content here is super easy and should be a drag and drop migration. You'll need to [submit a PR](https://link.setup.md/pr) but it's recommended you reach out to us on [Discord](https://link.setup.md/discord) so we can setup some indexing for your future content.

---

### Improving Content

As Minecraft continues to grow so will our project and we hope that if you spot inconsistancies in our project you'll hit the 'Edit Page' link at the bottom to submit a PR request with any corrections you wish to make.
4 changes: 3 additions & 1 deletion src/content/docs/enhancements/Anti-X Tools/anticheat.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ slug: e/anti-x/ac
title: Anti-Cheats
---

import MainStatusPill from '../../../../components/MainStatusPill.vue'

:::info
Throughout this guide 'Anti-Cheat(s)' may be referred to as 'AC' or 'ACs'
:::
Expand Down Expand Up @@ -42,7 +44,7 @@ We highly discourage the usage of auto-bans as no anti-cheat is perfect. If you

This list consists common ACs and some pros and cons of each AC.

#### NoCheatPlus
#### NoCheatPlus <MainStatusPill error>Java Only</MainStatusPill>

##### Pros
- Free and open-source
Expand Down
32 changes: 9 additions & 23 deletions src/content/docs/enhancements/Economy/chest.mdx
Original file line number Diff line number Diff line change
@@ -1,31 +1,17 @@
---
description: A focus on traditional chest based plugins for your servers economy.
slug: e/eco/chest
title: Chest Plugins
title: Chest Based
---

This section takes a look at current plugins that use craft-able chests for economy based tasks.
A chest shop is a Minecraft resource buying - selling enhancement that is fully craftable in game using normally a standard chest and a wooden sign. These solutions normally bring a more player-to-player style interraction with players chosing to rent space in an admin market / build their own market.

### Chest Shops
These solutions encourages more direct player to player interaction, these solutions aren't automated and rely on your end users buying and selling between one another.
### Examples

#### QuickShop
Easily the best Chest Shop plugin, containing pretty much every feature you might need.
We have collated a small list of plugins you can use to get you started with on your Minecraft server below.

<div>
<a class="button button--outline button--primary" href="https://www.spigotmc.org/resources/quickshop-reremake-1-19-ready-multi-currency.62575/">Spigot</a>
</div>

#### ChestShop
A simpler chest shop plugin that still has plenty of solid features.

<div>
<a class="button button--outline button--primary" href="https://www.spigotmc.org/resources/chestshop.51856/">Spigot</a>
</div>

#### DukesMart
Super basic Chest Shop plugin which uses Gold Ingots as a currency. Terra-Opus is making a fork with a couple improved changes this should also be worth a consideration.

<div>
<a class="button button--outline button--primary" href="https://github.com/jianbriggs/DukesMart">Github</a>
</div>
<ul class="pl-5 list-disc">
<li>[QuickShop](/e/pl/quickshop)</li>
<li>[ChestShop](/e/pl/chestshop)</li>
<li>[DukesMart](/e/pl/dukesmart)</li>
</ul>
2 changes: 1 addition & 1 deletion src/content/docs/enhancements/Economy/gui.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: A focus on GUI based plugins for your servers economy.
slug: e/eco/gui
title: GUI Plugins
title: GUI Based
---

This section takes a look at current plugins that have a user-interface for economy based tasks.
Expand Down
16 changes: 10 additions & 6 deletions src/content/docs/enhancements/Economy/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,18 @@ An economy is essential to your Minecraft server, it allows for players to buy a

Economies within Minecraft, much like the real world, can dictate supply and demand with availabilities of resources to your players. For example if you were running admin shops it would be possible to run a discount on certain items and random points within the year or if you want to make a product more valuable then this can be achieved too.

The goal with this section is to recommend some plugins that will allow you to build the framework for your own server's economy to take place.
The goal with this section is to highlight some viable options for your server along with some example plugins that will allow you to build the framework for your own server's economy to take place.



### Requirements
Most, if not all plugins require your server to have an Economy API (such as [Vault](/e/pl/vault)) and an Economy Handler (Such as TheNewEconomy) installed. A short list of handlers is below:
Most, if not all plugins require your server to have an Economy API (such as [Vault](/e/pl/vault)) and an Economy Handler installed.

* EssentialsX
* TheNewEconomy (Optional Vault Support)
* iConomy
* Gringott's Economy
Some example economy handlers are below:

<ul class="pl-5 list-disc">
<li>EssentialsX</li>
<li>TheNewEconomy (Optional Vault Support)</li>
<li>iConomy</li>
<li>Gringott's Economy</li>
</ul>
2 changes: 1 addition & 1 deletion src/content/docs/enhancements/Economy/shop.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: A focus on /shop based plugins for your servers economy.
slug: e/eco/shop
title: Shop Plugins
title: Command Based
---

### /shop Plugins
Expand Down
4 changes: 0 additions & 4 deletions src/content/docs/enhancements/Plugins/Free/AntiCrasher.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@
description: AntiCrasher fixes a crash exploit that affects every version, only fixed in very recent builds of paper/pufferfish/purpur for 1.20.2 and a backport for pufferfish 1.20.1
slug: e/pl/anticrasher
title: AntiCrasher
sidebar:
badge:
text: New
variant: note
---

Fixes a very popular and very used crash exploit that affects most versions of Minecraft
Expand Down
20 changes: 20 additions & 0 deletions src/content/docs/enhancements/Plugins/Free/chestshop.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
description: A chest based player shop plugin to enhance your economy.
slug: e/pl/chestshop
title: ChestShop
---

import MainStatusPill from '../../../../../components/MainStatusPill.vue'
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

#### This enhancement supports
<br/>
<MainStatusPill info>Spigot / Paper & forks only</MainStatusPill>
<br/>
A simple bare bones chest shop plugin, think 'QuickShop' without all the fancy bells and whistles. ChestShop makes a great plugin for anyone who just wants to get some simple buying and selling going in their server.

<LinkCard
title="Spigot"
description="View ChestShop's official Spigot page for downloading the plugin."
href="https://www.spigotmc.org/resources/chestshop.51856/"
/>
20 changes: 20 additions & 0 deletions src/content/docs/enhancements/Plugins/Free/dukesmart.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
description: A chest based player shop plugin to enhance your economy.
slug: e/pl/dukesmart
title: DukesMart
---

import MainStatusPill from '../../../../../components/MainStatusPill.vue'
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

#### This enhancement supports
<br/>
<MainStatusPill info>Spigot / Paper & forks only</MainStatusPill>
<br/>
A plugin to watch as the light weight chest shop plugin was rumoured to be getting one final breath of life with a fork.

<LinkCard
title="Github"
description="View DukesMart's official Github page for downloading the plugin."
href="https://github.com/jianbriggs/DukesMart"
/>
Loading

0 comments on commit 07bc967

Please sign in to comment.