split the docs into categories (#75)

Co-authored-by: youhavetrouble <[email protected]> Co-authored-by: RhythmicSys <[email protected]>
PurpurMC · Sep 22, 2023 · b0fb98c · b0fb98c
1 parent 9102b25
commit b0fb98c
Show file tree

Hide file tree

Showing 17 changed files with 664 additions and 65 deletions.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,44 +1,70 @@
 # Project information
-site_name: Purpur Documentation
+site_name: PurpurMC Documentation
 site_url: https://purpurmc.org/docs
 site_author: granny
 site_description: >-
   The official documentation for Purpur.
   Purpur is a fork of Pufferfish (and by extension, Paper) with the goal of providing new and interesting configuration options, which allow for creating a unique gameplay experience not seen anywhere else.
 docs_dir: mkdocs
 nav:
-    - Home: index.md
-    - Installation: Installation.md
-    - Configuration: Configuration.md
-    - Commands: Commands.md
-    - Permissions: Permissions.md
-    - Frequently Asked Questions: FAQ.md
+    - index.md
+    - Purpur:
+      - Purpur: purpur/index.md
+      - Installation: purpur/installation.md
+      - Configuration: purpur/configuration.md
+      - Commands: purpur/commands.md
+      - Permissions: purpur/permissions.md
+      - Frequently Asked Questions: purpur/faq.md
+    - PurpurExtras:
+      - PurpurExtras: purpurextras/index.md
+      - Installation: purpurextras/installation.md
+      - Configuration: purpurextras/configuration.md
+      - Commands: purpurextras/commands.md
+      # - Permissions: purpurextras/permissions.md
+      # - Frequently Asked Questions: purpurextras/faq.md
+    - PurpurPacks:
+      - PurpurPacks: purpurpacks/index.md
+      # - Installation: purpurpacks/installation.md
+      # - Configuration: purpurpacks/configuration.md
+      # - Commands: purpurpacks/commands.md
+      # - Permissions: purpurpacks/permissions.md
+      # - Frequently Asked Questions: purpurpacks/faq.md
 repo_url: https://github.com/PurpurMC/PurpurDocs
 repo_name: PurpurDocs
 edit_uri: edit/main/mkdocs/
 extra_css:
   - stylesheets/extra.css
 plugins:
   - search
+  - ezlinks
   - markdownextradata
   - autolink_references:
       autolinks:
           - reference_prefix: MC-
             target_url: https://bugs.mojang.com/browse/MC-<num>
   - redirects:
       redirect_maps:
-          'commands.md': 'Commands.md'
-          'cmds.md': 'Commands.md'
-          'configuration.md': 'Configuration.md'
-          'config.md': 'Configuration.md'
-          'permissions.md': 'Permissions.md'
-          'perms.md': 'Permissions.md'
-          'faq.md': 'FAQ.md'
+          'commands.md': 'purpur/commands.md'
+          'cmds.md': 'purpur/commands.md'
+          'configuration.md': 'purpur/configuration.md'
+          'config.md': 'purpur/configuration.md'
+          'permissions.md': 'purpur/permissions.md'
+          'perms.md': 'purpur/permissions.md'
+          'faq.md': 'purpur/faq.md'
+          'Commands.md': 'purpur/commands.md'
+          'Configuration.md': 'purpur/configuration.md'
+          'FAQ.md': 'purpur/faq.md'
+          'Installation.md': 'purpur/installation.md'
+          'Log4j.md': 'purpur/log4j.md'
+          'Permissions.md': 'purpur/permissions.md'
 theme:
   name: material
   custom_dir: overrides
   favicon: images/purpur-small.png
   logo: images/purpur-small.png
+  features:
+    - navigation.tabs
+    - navigation.indexes
   palette:
     - scheme: slate
       primary: light blue
@@ -68,7 +94,12 @@ extra:
     build:
       number: 1976
       commit: 68117a4e
+  purpur_extras:
+    downloads: https://modrinth.com/plugin/purpurextras/versions
+    source: https://github.com/PurpurMC/PurpurExtras
   social:
     - icon: fontawesome/brands/discord
       link: https://purpurmc.org/discord
       name: Purpur Discord Server
+  purpur_packs:
+    source: https://github.com/PurpurMC/PurpurPacks
diff --git a/mkdocs/Commands.md → mkdocs/purpur/commands.md b/mkdocs/Commands.md → mkdocs/purpur/commands.md
@@ -43,7 +43,7 @@ Purpur adds a few new commands to the game.
 
 ## /demo
 ??? info "Image of the Demo Screen 📷"
-    ![Demo Screen](images/demo.png)
+    ![Demo Screen](demo.png)
 - This command shows the demo screen to players if you have the `bukkit.command.demo.other` permission. If you do not specify a player name or player entity selector (`@a`, `@r`, etc) it will show the demo screen to yourself.
 
 - **examples**:
@@ -61,7 +61,7 @@ Purpur adds a few new commands to the game.
 
 ## /credits
 ??? info "Image of the Credits screen 📷"
-    ![Credits screen](images/credits.png)
+    ![Credits screen](credits.png)
 - This command shows the credits screen to players if you have the `bukkit.command.credits.other` permission. If you do not specify a player name or player entity selector (`@a`, `@r`, etc) it will show the credits screen to yourself.
 
 - **examples**:
@@ -79,7 +79,7 @@ Purpur adds a few new commands to the game.
 
 ## /tpsbar
 ??? info "Image of the tpsbar in action 📷"
-    ![TPSBar in action](images/bossbar.gif)
+    ![TPSBar in action](bossbar.gif)
 - This command shows a bossbar showcasing your current TPS/MSPT to players if you have the `bukkit.command.tpsbar.other` permission. If you do not specify a player name or player entity selector (`@a`, `@r`, etc) it will show the tpsbar to yourself.
 
 - **examples**:
@@ -97,7 +97,7 @@ Purpur adds a few new commands to the game.
 
 ## /compass
 ??? info "Image of the compass in action 📷"
-    ![Compass in action](images/bossbar.gif)
+    ![Compass in action](bossbar.gif)
 - This command shows a bossbar showcasing your current facing direction.
 
 - **examples**

diff --git a/mkdocs/Configuration.md → mkdocs/purpur/configuration.md b/mkdocs/Configuration.md → mkdocs/purpur/configuration.md
@@ -60,7 +60,7 @@ Global settings affect all worlds on the server as well as the core server funct
         - **description**: Output of `<seconds>` placeholder in [command.uptime.format](#format) option
 * #### gamemode
     * ##### requires-specific-permission
-        - Requires [`minecraft.command.gamemode.<gamemode>`](../Permissions#minecraftcommandgamemodegamemode) permission
+        - Requires [`minecraft.command.gamemode.<gamemode>`](permissions#minecraftcommandgamemodegamemode) permission
         - **default**: false
         - **description**: Set to true for each gamemode to require its own permission
 * #### tpsbar
@@ -155,7 +155,7 @@ Global settings affect all worlds on the server as well as the core server funct
     * ##### title
         - **default**: "S  ·  ◈  ·  ◈  ·  ◈  ·  SW  ·  ◈  ·  ◈  ·  ◈  ·  W  ·  ◈  ·  ◈  ·  ◈  ·  NW  ·  ◈  ·  ◈  ·  ◈  ·  N  ·  ◈  ·  ◈  ·  ◈  ·  NE  ·  ◈  ·  ◈  ·  ◈  ·  E  ·  ◈  ·  ◈  ·  ◈  ·  SE  ·  ◈  ·  ◈  ·  ◈  ·  
 S  ·  ◈  ·  ◈  ·  ◈  ·  SW  ·  ◈  ·  ◈  ·  ◈  ·  W  ·  ◈  ·  ◈  ·  ◈  ·  NW  ·  ◈  ·  ◈  ·  ◈  ·  N  ·  ◈  ·  ◈  ·  ◈  ·  NE  ·  ◈  ·  ◈  ·  ◈  ·  E  ·  ◈  ·  ◈  ·  ◈  ·  SE  ·  ◈  ·  ◈  ·  ◈  ·  "
-        - **description**: The format of the bossbar when the server runs the [`/compass`](../Commands#compass) command
+        - **description**: The format of the bossbar when the server runs the [`/compass`](commands#compass) command
 
     * ##### overlay
         - **default**: PROGRESS
@@ -265,7 +265,7 @@ Requires the [`kick-if-idle`](#kick-if-idle) setting to be `false`
 - **description**: The suffix that shows up on the playerlist after someone's name when they're AFK
 
 #### cannot-ride-mob
-Requires the [`allow.ride.<mob_id>`](../Permissions#allowridemob_id) permission
+Requires the [`allow.ride.<mob_id>`](permissions#allowridemob_id) permission
 
 - **default**: &lt;red>You cannot mount that mob
 - **description**: Message that shows when someone tries to mount a mob they're not allowed to.
@@ -277,32 +277,32 @@ Requires the [`damage-if-sprinting`](#damage-if-sprinting) option to be enabled
 - **description**: Actionbar message that shows when someone attempts to run with scissors
 
 #### ping-command-output
-Requires the [`bukkit.command.ping`](../Permissions#bukkitcommandping) permission
+Requires the [`bukkit.command.ping`](permissions#bukkitcommandping) permission
 
 - **default**: &lt;green>%s's ping is %sms
 - **description**: Output when `/ping <user>` is run.
 
 #### uptime-command-output
-Requires the [`bukkit.command.uptime`](../Permissions#bukkitcommanduptime) permission
+Requires the [`bukkit.command.uptime`](permissions#bukkitcommanduptime) permission
 `<uptime>` - The format from [`<global>.command.uptime.format`](#format)
 
 - **default**: &lt;green>Server uptime is &lt;uptime>
 - **description**: Message that shows when the `/uptime` command is ran.
 
 #### demo-command-output
-Requires the [`bukkit.command.demo`](../Permissions#bukkitcommanddemo) permission
+Requires the [`bukkit.command.demo`](permissions#bukkitcommanddemo) permission
 
 - **default**: &lt;green>%s has been shown the demo screen
 - **description**: Message that shows when the demo screen is enabled for a user using the `/demo` command.
 
 #### credits-command-output
-Requires the [`bukkit.command.credits`](../Permissions#bukkitcommandcredits) permission
+Requires the [`bukkit.command.credits`](permissions#bukkitcommandcredits) permission
 
 - **default**: &lt;green>%s has been shown the end credits
 - **description**: Message that shows when the credits screen is enabled for a user using the `/credits` command.
 
 #### tpsbar-command-output
-Requires the [`bukkit.command.tpsbar`](../Permissions#bukkitcommandtpsbar) permission
+Requires the [`bukkit.command.tpsbar`](permissions#bukkitcommandtpsbar) permission
 
 - **default**: &lt;green>Tpsbar toggled &lt;onoff> for &lt;target>
 - **description**: Message that shows when the tpsbar is enabled for a user using the `/tpsbar` command.
@@ -382,7 +382,7 @@ Requires the [`bukkit.command.tpsbar`](../Permissions#bukkitcommandtpsbar) permi
     - **description**: When enabled, ender chests should have six rows of inventory space
 * ##### use-permissions-for-rows
     - Requires [`ender_chest.six-rows`](#six-rows) to be true
-    - Requires [`purpur.enderchest.rows.<number>`](../Permissions#purpurenderchestrowsnumber) permission
+    - Requires [`purpur.enderchest.rows.<number>`](permissions#purpurenderchestrowsnumber) permission
     - **default**: false
     - **description**: Use permission nodes to determine the number of rows. By default, with this setting enabled, all players have `six` rows unless otherwise specified using permissions.
 
@@ -725,7 +725,7 @@ For a more clear explanation of the world settings section of the config, feel f
 
 #### sign
 * ##### allow-colors
-    - Requires [`purpur.sign.color`](../Permissions#purpursigncolor), [`purpur.sign.style`](../Permissions#purpursignstyle), and/or [`purpur.sign.magic`](../Permissions#purpursignmagic) permission
+    - Requires [`purpur.sign.color`](permissions#purpursigncolor), [`purpur.sign.style`](permissions#purpursignstyle), and/or [`purpur.sign.magic`](permissions#purpursignmagic) permission
     - **default**: false
     - **description**: Allow players to use color codes on signs
 #### magma-block
@@ -832,11 +832,11 @@ For a more clear explanation of the world settings section of the config, feel f
     - **description**: Allows anvils to be placed by dispensers
 #### anvil
 * ##### use-mini-message
-    - Requires [`purpur.anvil.minimessage`](../Permissions#purpuranvilminimessage) permission
+    - Requires [`purpur.anvil.minimessage`](permissions#purpuranvilminimessage) permission
     - **default**: false
     - **description**:  Allows players to use MiniMessage tags in an anvil.
 * ##### allow-colors
-    - Requires [`purpur.anvil.color`](../Permissions#purpuranvilcolor) permission
+    - Requires [`purpur.anvil.color`](permissions#purpuranvilcolor) permission
     - **default**: false
     - **description**: Allows players to use color codes in anvils
 * ##### iron-ingots-used-for-repair
@@ -3305,7 +3305,7 @@ based on the world difficulty. [Read more here]({{ project.source }}/blob/61fc0a
 - **default**: 0
 - **description**: Disabled by default (0), Amount of ticks an entity will live before disappearing. Interacting with a player resets the timer
 #### silk-touch
-Requires the [`purpur.drop.spawners`](../Permissions#purpurdropspawners) and [`purpur.place.spawners`](../Permissions#purpurplacespawners) permissions
+Requires the [`purpur.drop.spawners`](permissions#purpurdropspawners) and [`purpur.place.spawners`](permissions#purpurplacespawners) permissions
 
 * ##### enabled
     - **default**: false
@@ -3531,7 +3531,7 @@ Requires the [`purpur.drop.spawners`](../Permissions#purpurdropspawners) and [`p
 * ##### compass
     * ###### holding-shows-bossbar
         - **default**: false
-        - **description**: If the bossbar from the [`/compass`](../Commands#compass) command should show when holding a compass
+        - **description**: If the bossbar from the [`/compass`](commands#compass) command should show when holding a compass
 * ##### glow_berries
     * ###### eat-glow-duration
         - **default**: 0

diff --git a/mkdocs/FAQ.md → mkdocs/purpur/faq.md b/mkdocs/FAQ.md → mkdocs/purpur/faq.md