Switch to mdbook for docs

.gitlab-ci.yml

@@ -1,14 +1,3 @@
 include:
   - remote: 'https://jfmods.gitlab.io/scripts/jfmod.yml'
-
+  - remote: 'https://jfmods.gitlab.io/scripts/docs.yml'
-pages:
-  image: python:3.8-buster
-  stage: deploy
-  script:
-  - pip install mkdocs
-  - mkdocs build
-  artifacts:
-    paths:
-    - public
-  only:
-  - master

book.toml

@@ -0,0 +1,16 @@
+[book]
+authors = ["JFronny"]
+language = "en"
+multilingual = false
+src = "docs"
+title = "respackopts docs"
+description = "Documentation for the respackopts config engine for minecraft resource and data packs"
+
+[build]
+build-dir = "public"
+
+[output.html]
+git-repository-url = "https://gitlab.com/jfmods/respackopts"
+git-repository-icon = "fa-gitlab"
+edit-url-template = "https://gitlab.com/jfmods/respackopts/edit/master/{path}"
+site-url = "https://jfmods.gitlab.io/respackopts"

docs/README.md

@@ -7,19 +7,6 @@ Respackopts is available on [Modrinth](https://modrinth.com/mod/respackopts) and
 - Resource Packs
 - DataPacks
 
-## Features
-| Feature                                                                                         | Status |
-|-------------------------------------------------------------------------------------------------|--------|
-| Boolean (toggle) inputs                                                                         | ✅      |
-| Slider inputs                                                                                   | ✅      |
-| Number inputs                                                                                   | ✅      |
-| String (Text) inputs                                                                            | ✅      |
-| Conditional file loading                                                                        | ✅      |
-| Fallback files                                                                                  | ✅      |
-| Not, And, Or, Nor, Xor, Eq Operations for conditions                                            | ✅      |
-| Text file modification using [Starscript](https://github.com/MeteorDevelopment/starscript/wiki) | ✅      |
-| Directory .rpo support                                                                          | 🔄     |
-
 ## Packs using Respackopts
 This list doesn't include all packs using respackopts, just some I know of.
 If you want your pack added/removed from here, you can open a PR

docs/SUMMARY.md

@@ -0,0 +1,20 @@
+# Summary
+
+- [About](./README.md)
+
+# Setup
+- [Creating a Screen](./setup/MainConfig.md)
+- [Advanced config entries](./setup/AdvancedConfig.md)
+- [Translating your config](./setup/Translations.md)
+- [Debugging](./setup/Debugging.md)
+
+# Select files
+- [Toggle Files](./filerpo/ToggleFiles.md)
+- [Switch between two files](./filerpo/ToggleFilesWithFallback.md)
+- [Select one of multiple files](./filerpo/MultipleFileSelection.md)
+
+# Additional
+- [Advanced Conditions](./additional/AdvancedConditions.md)
+- [Usage in Shader Packs](./additional/Shaders.md)
+- [Resource Expansion](./additional/ResourceExpansion.md)
+- [Changes between versions](./additional/Migrations.md)

docs/additional/ResourceExpansion.md

@@ -1,4 +1,4 @@
-# Resource expansion
+# Resource Expansion
 Sometimes, you may wish to use respackopts values inside your text files (for example as model transforms),
 without switching between a bunch of similar files. For this purpose, respackopts allows replacing text in files via resource expansion.
 

docs/additional/Shaders.md

@@ -1,4 +1,4 @@
-# Usage in fabulous/canvas/frex shaders
+# Usage in Shader Packs
 ## Getting started
 All you need to do to access respackotps values is paste the following in a file where you want them according to your renderer:
 

docs/filerpo/MultipleFileSelection.md

@@ -2,7 +2,7 @@
 This Allows you to pick between multiple files (3 or more files) using similar logic to [Toggle Files](./ToggleFiles.md)
 But this requires multiple `.rpo` files to achieve the desired goal.
 You will need the `PackID` and `EntryName` from your `respackopts.json5` that you created earlier
-if you have not, see [Main Config](./MainConfig.md) on how to do so.
+if you have not, see [Main Config](../setup/MainConfig.md) on how to do so.
 <br>
 
 You will need to navigate to the file you would like to toggle inside your resource, and create a `.rpo` file for it in the same folder (directory).

docs/filerpo/ToggleFiles.md

@@ -2,7 +2,7 @@
 A condition can be looked at like an `IF` statement simply returning true/false to configure whether the texture/file should be loaded into the pack.
 (Turns the texture "on" or "off").
 You will need the `Pack ID` and `Entry Name` from your `respackopts.json5` that you created earlier
-if you have not, see [Main Config](./MainConfig.md) on how to do so.
+if you have not, see [Main Config](../setup/MainConfig.md) on how to do so.
 <br>
 
 You will need to navigate to the file you would like to toggle inside your resource, and create a `.rpo` file for it in the same folder(directory).
@@ -26,7 +26,7 @@ You will need to navigate to the file you would like to toggle inside your resou
 }
 ```
 
-For more information on conditions, [read this](./AdvancedConditions.md)
+For more information on conditions, [read this](../additional/AdvancedConditions.md)
 
 ### Toggle Directories
 Directories ("Folders") can also be toggled without toggling individual files.

docs/filerpo/ToggleFilesWithFallback.md

@@ -2,7 +2,7 @@
 This is a simple `IF` statement simply returning true/false to if the texture/file should be loaded into the pack.
 (Pick one file over another).
 You will need the `Pack ID` and `Entry Name` from your `respackopts.json5` that you created earlier
-if you have not, see [Main Config](./MainConfig.md) on how to do so.
+if you have not, see [Main Config](../setup/MainConfig.md) on how to do so.
 <br>
 
 You will need to navigate to the file you would like to toggle inside your resource, and create a `.rpo` file for it in the same directory (folder).

mkdocs.yml

@@ -1,26 +0,0 @@
-site_name: respackopts docs
-site_url: https://jfmods.gitlab.io/respackopts
-theme:
-    name: readthedocs
-    hljs_languages:
-        - glsl
-site_dir: public
-repo_url: https://gitlab.com/jfmods/respackopts
-site_description: Documentation for the respackopts config engine for minecraft resource and data packs
-site_author: JFronny
-nav:
-  - 'README.md'
-  - 'Setting up':
-      - 'MainConfig.md'
-      - 'AdvancedConfig.md'
-      - 'Translations.md'
-      - 'Debugging.md'
-  - 'Select files':
-      - 'ToggleFiles.md'
-      - 'ToggleFilesWithFallback.md'
-      - 'MultipleFileSelection.md'
-  - 'Additional':
-      - 'AdvancedConditions.md'
-      - 'Shaders.md'
-      - 'ResourceExpansion.md'
-      - 'Migrations.md'