diff --git a/_config.yml b/_config.yml index f7cd45b..3dd3315 100644 --- a/_config.yml +++ b/_config.yml @@ -1,4 +1,4 @@ -favicon_ico: "https://cedmod.nl/favicon.ico" +logo: "/assets/images/logo.png" title: CedMod Documentation description: Documentation for Installation and Usage of CedMod theme: just-the-docs @@ -7,10 +7,13 @@ color_scheme: dark url: https://docs.cedmod.nl baseurl: / +aux_links_new_tab: true aux_links: "CedMod on GitHub": - "https://github.com/CedModV2" +heading_anchors: true + nav_external_links: - title: CedMod on GitHub url: https://github.com/CedModV2 diff --git a/assets/images/logo.png b/assets/images/logo.png new file mode 100644 index 0000000..8878d35 Binary files /dev/null and b/assets/images/logo.png differ diff --git a/docs/Setup/Installation/index.md b/docs/Setup/Installation/index.md deleted file mode 100644 index c75547e..0000000 --- a/docs/Setup/Installation/index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Installation -parent: Setup -layout: default -has_children: true ---- - -# Installation -{: .fs-9 } - -Installation guides to install exiled for NWAPI or Exiled/Exiled Reboot -{: .fs-6 .fw-300 } \ No newline at end of file diff --git a/docs/Setup/index.md b/docs/setup/index.md similarity index 100% rename from docs/Setup/index.md rename to docs/setup/index.md diff --git a/docs/Setup/Installation/exiled.md b/docs/setup/installation/exiled.md similarity index 80% rename from docs/Setup/Installation/exiled.md rename to docs/setup/installation/exiled.md index 0ee3d6c..3380270 100644 --- a/docs/Setup/Installation/exiled.md +++ b/docs/setup/installation/exiled.md @@ -8,22 +8,32 @@ layout: default # Installation for Exiled {: .warning } -CedMod does currently not support Exiled Reboot 9.0.0 beta. +CedMod does currently not support the Exiled Reboot 9.0.0 beta. [Exiled](https://github.com/ExMod-Team/EXILED){: .btn .mr-2 } [Exiled Reboot](https://github.com/Exiled-Team/EXILED){: .btn .mr-2 } +{: .no_toc } + +--- + +## Table of Contents +{: .no_toc .text-delta } + +1. TOC + {:toc} ## How to install Exiled Download the latest compatible release of either **Exiled** or **Exiled Reboot**. It is not relevant -which of them you use but due note that they have to completely different development teams +which of them you use but due note that they have two completely different development teams and are aiming for different goals. -On a guide on how to install Exiled/Exiled Reboot on their official docs. +If you want a guide on how to install Exiled/Exiled Reboot, +you can find them their official docs. For Exiled go [here](https://github.com/ExMod-Team/EXILED/blob/master/.github/documentation/README.md#installation), for Exiled Reboot look [here](https://github.com/Exiled-Team/EXILED?tab=readme-ov-file#installation). -The guides are practically identical but could change in the future when development of the two changes more and more. +The guides are practically identical, but could change in the future when development of the two changes more and more. ## Getting the CedMod release diff --git a/docs/setup/installation/index.md b/docs/setup/installation/index.md new file mode 100644 index 0000000..3cb19ac --- /dev/null +++ b/docs/setup/installation/index.md @@ -0,0 +1,19 @@ +--- +title: Installation +parent: Setup +layout: default +has_children: true +--- + +# Installation +{: .fs-9 } + +Installation guides to install exiled for NWAPI or Exiled/Exiled Reboot +{: .fs-6 .fw-300 } + +## What to choose? + +The basic difference between **Exiled** and **NWAPI** is +that Exiled has an integrated permission system while NWAPI doesn't. +Meaning if you use Exiled for your permissions and everything you should stick with the CedMod versions for exiled. +If you already use NWAPIPermissionSystem you may want to consider using the NWAPI version of CedMod \ No newline at end of file diff --git a/docs/Setup/Installation/nwapi.md b/docs/setup/installation/nwapi.md similarity index 86% rename from docs/Setup/Installation/nwapi.md rename to docs/setup/installation/nwapi.md index 1856d4f..9066978 100644 --- a/docs/Setup/Installation/nwapi.md +++ b/docs/setup/installation/nwapi.md @@ -7,7 +7,16 @@ layout: default # Installation for NWAPI -NWAPI is the preinstalled plugins api for SCP: Secret Laboratory servers and does not need any extra installation +NWAPI is the preinstalled plugin api for SCP: Secret Laboratory servers and does not need any extra installation +{: .no_toc } + +--- + +## Table of Contents +{: .no_toc .text-delta } + +1. TOC + {:toc} ## Getting the CedMod release diff --git a/docs/Setup/Instance/create.md b/docs/setup/instance/create.md similarity index 100% rename from docs/Setup/Instance/create.md rename to docs/setup/instance/create.md diff --git a/docs/Setup/Instance/index.md b/docs/setup/instance/index.md similarity index 100% rename from docs/Setup/Instance/index.md rename to docs/setup/instance/index.md diff --git a/docs/Setup/Instance/sync.md b/docs/setup/instance/sync.md similarity index 100% rename from docs/Setup/Instance/sync.md rename to docs/setup/instance/sync.md diff --git a/index.md b/index.md index 28409e1..3573592 100644 --- a/index.md +++ b/index.md @@ -19,8 +19,10 @@ This documentation is currently not complete and is still WIP [Join our Discord](https://discord.com/invite/p69SGfwxxm){: .btn .mr-2 } [GitHub](https://github.com/CedModV2/CedMod){: .btn .mr-2 } +--- + With CedMod you are able to moderate your server more easily than ever before. -Use the webpanel for managing bans, mutes, permissions and your staff permissions. +Use the webpanel for managing bans, mutes, and permissions. CedMod is used by over **400** Servers worldwide and stores over **300.000** BanLogs and almost **100.000** Warnings. ## Getting Started @@ -36,7 +38,7 @@ If you want to view a more complete installation guide, go to [the instance creation guide](https://docs.cedmod.nl/docs/Setup/Instance/) ## About CedMod -CedMod All Rights Reserved by [ced777ric](https://github.com/ced777ric) +CedMod, All Rights Reserved by [ced777ric](https://github.com/ced777ric) ### Licence Agreements @@ -50,8 +52,8 @@ You are free to contribute to CedMod development if you'd like. Fork the [repository](https://github.com/CedModV2/CedMod), commit your changes to the fork and then create a pull request to propose the changes to the maintainers. -{: .warning } +{: .attention } When proposing changes, make sure they are well tested and don't break any other features. CedMod is used by many servers and has to be stable for optimal usage. Also make sure to explain exactly what you changed in the pull request. {: .note } -The backend of CedMod is closed source and will remain that way. If you'd like to contribute to the development of the backend, you can apply for a staff position using the [application form](https://docs.google.com/forms/d/1JJKZOXOv6_ew8bExxGvLvaSBzdgCNlYteGnWNOMQPXU/edit). The CedMod team reviews your application and then decides if it is valid or not. You need to answer the questions truthfully for the best chances, lying won't bring you far \ No newline at end of file +The backend of CedMod is closed source and will remain that way. If you'd like to contribute to the development of the backend, you can apply for a staff position with the [application form](https://docs.google.com/forms/d/1JJKZOXOv6_ew8bExxGvLvaSBzdgCNlYteGnWNOMQPXU/edit). The CedMod team reviews your application and then decides if it is valid or not. You need to answer the questions truthfully for the best chances, lying won't bring you far \ No newline at end of file