From d6b03e63cdd5bc0fb95c40c10dd20d3b11442e8c Mon Sep 17 00:00:00 2001 From: JFronny Date: Tue, 30 Aug 2022 13:31:08 +0200 Subject: [PATCH] Switch to mdbook for docs --- .gitlab-ci.yml | 13 +-------- book.toml | 16 +++++++++++ docs/README.md | 13 --------- docs/SUMMARY.md | 20 ++++++++++++++ docs/{ => additional}/AdvancedConditions.md | 0 docs/{ => additional}/Migrations.md | 0 docs/{ => additional}/ResourceExpansion.md | 2 +- docs/{ => additional}/Shaders.md | 2 +- docs/{ => filerpo}/MultipleFileSelection.md | 2 +- docs/{ => filerpo}/ToggleFiles.md | 4 +-- docs/{ => filerpo}/ToggleFilesWithFallback.md | 2 +- docs/{ => setup}/AdvancedConfig.md | 0 docs/{ => setup}/Debugging.md | 0 docs/{ => setup}/MainConfig.md | 0 docs/{ => setup}/Translations.md | 0 docs/{ => setup}/img/ExamplePackBoolean.png | Bin docs/{ => setup}/img/ExamplePackCategory.png | Bin docs/{ => setup}/img/ExamplePackEnum.png | Bin docs/{ => setup}/img/ExamplePackEnum2.png | Bin docs/{ => setup}/img/ExamplePackNumber.png | Bin docs/{ => setup}/img/ExamplePackSlider.png | Bin .../img/ExamplePackTranslations.png | Bin mkdocs.yml | 26 ------------------ 23 files changed, 43 insertions(+), 57 deletions(-) create mode 100644 book.toml create mode 100644 docs/SUMMARY.md rename docs/{ => additional}/AdvancedConditions.md (100%) rename docs/{ => additional}/Migrations.md (100%) rename docs/{ => additional}/ResourceExpansion.md (99%) rename docs/{ => additional}/Shaders.md (97%) rename docs/{ => filerpo}/MultipleFileSelection.md (94%) rename docs/{ => filerpo}/ToggleFiles.md (89%) rename docs/{ => filerpo}/ToggleFilesWithFallback.md (94%) rename docs/{ => setup}/AdvancedConfig.md (100%) rename docs/{ => setup}/Debugging.md (100%) rename docs/{ => setup}/MainConfig.md (100%) rename docs/{ => setup}/Translations.md (100%) rename docs/{ => setup}/img/ExamplePackBoolean.png (100%) rename docs/{ => setup}/img/ExamplePackCategory.png (100%) rename docs/{ => setup}/img/ExamplePackEnum.png (100%) rename docs/{ => setup}/img/ExamplePackEnum2.png (100%) rename docs/{ => setup}/img/ExamplePackNumber.png (100%) rename docs/{ => setup}/img/ExamplePackSlider.png (100%) rename docs/{ => setup}/img/ExamplePackTranslations.png (100%) delete mode 100644 mkdocs.yml diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index aa13c18..2c6067f 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,14 +1,3 @@ include: - remote: 'https://jfmods.gitlab.io/scripts/jfmod.yml' - -pages: - image: python:3.8-buster - stage: deploy - script: - - pip install mkdocs - - mkdocs build - artifacts: - paths: - - public - only: - - master + - remote: 'https://jfmods.gitlab.io/scripts/docs.yml' \ No newline at end of file diff --git a/book.toml b/book.toml new file mode 100644 index 0000000..a12050a --- /dev/null +++ b/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" diff --git a/docs/README.md b/docs/README.md index 0f98839..2992dcb 100644 --- a/docs/README.md +++ b/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 diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md new file mode 100644 index 0000000..29f95c4 --- /dev/null +++ b/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) \ No newline at end of file diff --git a/docs/AdvancedConditions.md b/docs/additional/AdvancedConditions.md similarity index 100% rename from docs/AdvancedConditions.md rename to docs/additional/AdvancedConditions.md diff --git a/docs/Migrations.md b/docs/additional/Migrations.md similarity index 100% rename from docs/Migrations.md rename to docs/additional/Migrations.md diff --git a/docs/ResourceExpansion.md b/docs/additional/ResourceExpansion.md similarity index 99% rename from docs/ResourceExpansion.md rename to docs/additional/ResourceExpansion.md index 48ded49..0627caa 100644 --- a/docs/ResourceExpansion.md +++ b/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. diff --git a/docs/Shaders.md b/docs/additional/Shaders.md similarity index 97% rename from docs/Shaders.md rename to docs/additional/Shaders.md index c3eb803..c0b232e 100644 --- a/docs/Shaders.md +++ b/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: diff --git a/docs/MultipleFileSelection.md b/docs/filerpo/MultipleFileSelection.md similarity index 94% rename from docs/MultipleFileSelection.md rename to docs/filerpo/MultipleFileSelection.md index 530caa6..a712fe3 100644 --- a/docs/MultipleFileSelection.md +++ b/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.
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). diff --git a/docs/ToggleFiles.md b/docs/filerpo/ToggleFiles.md similarity index 89% rename from docs/ToggleFiles.md rename to docs/filerpo/ToggleFiles.md index 697cc00..414d723 100644 --- a/docs/ToggleFiles.md +++ b/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.
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. diff --git a/docs/ToggleFilesWithFallback.md b/docs/filerpo/ToggleFilesWithFallback.md similarity index 94% rename from docs/ToggleFilesWithFallback.md rename to docs/filerpo/ToggleFilesWithFallback.md index 8ab6f57..7dbb34f 100644 --- a/docs/ToggleFilesWithFallback.md +++ b/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.
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). diff --git a/docs/AdvancedConfig.md b/docs/setup/AdvancedConfig.md similarity index 100% rename from docs/AdvancedConfig.md rename to docs/setup/AdvancedConfig.md diff --git a/docs/Debugging.md b/docs/setup/Debugging.md similarity index 100% rename from docs/Debugging.md rename to docs/setup/Debugging.md diff --git a/docs/MainConfig.md b/docs/setup/MainConfig.md similarity index 100% rename from docs/MainConfig.md rename to docs/setup/MainConfig.md diff --git a/docs/Translations.md b/docs/setup/Translations.md similarity index 100% rename from docs/Translations.md rename to docs/setup/Translations.md diff --git a/docs/img/ExamplePackBoolean.png b/docs/setup/img/ExamplePackBoolean.png similarity index 100% rename from docs/img/ExamplePackBoolean.png rename to docs/setup/img/ExamplePackBoolean.png diff --git a/docs/img/ExamplePackCategory.png b/docs/setup/img/ExamplePackCategory.png similarity index 100% rename from docs/img/ExamplePackCategory.png rename to docs/setup/img/ExamplePackCategory.png diff --git a/docs/img/ExamplePackEnum.png b/docs/setup/img/ExamplePackEnum.png similarity index 100% rename from docs/img/ExamplePackEnum.png rename to docs/setup/img/ExamplePackEnum.png diff --git a/docs/img/ExamplePackEnum2.png b/docs/setup/img/ExamplePackEnum2.png similarity index 100% rename from docs/img/ExamplePackEnum2.png rename to docs/setup/img/ExamplePackEnum2.png diff --git a/docs/img/ExamplePackNumber.png b/docs/setup/img/ExamplePackNumber.png similarity index 100% rename from docs/img/ExamplePackNumber.png rename to docs/setup/img/ExamplePackNumber.png diff --git a/docs/img/ExamplePackSlider.png b/docs/setup/img/ExamplePackSlider.png similarity index 100% rename from docs/img/ExamplePackSlider.png rename to docs/setup/img/ExamplePackSlider.png diff --git a/docs/img/ExamplePackTranslations.png b/docs/setup/img/ExamplePackTranslations.png similarity index 100% rename from docs/img/ExamplePackTranslations.png rename to docs/setup/img/ExamplePackTranslations.png diff --git a/mkdocs.yml b/mkdocs.yml deleted file mode 100644 index eb7c32d..0000000 --- a/mkdocs.yml +++ /dev/null @@ -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' \ No newline at end of file