From e0fdd82777b3f00f2d9b17d5b89e60b34992aa09 Mon Sep 17 00:00:00 2001 From: c-128 Date: Thu, 29 Aug 2024 22:55:41 +0200 Subject: [PATCH] move to mkdocs --- .gitignore | 1 + README.md => docs/index.md | 6 ++++-- {mods => docs/mods}/boring_smp/index.md | 2 +- .../boring_smp/recipes/diamond_from_shards.png | Bin .../recipes/diamond_shard_from_diamonds.png | Bin .../boring_smp/recipes/tweaks_activator_rail.png | Bin .../recipes/tweaks_bundle_from_leather.png | Bin .../recipes/tweaks_bundle_from_rabbit_hide.png | Bin .../boring_smp/recipes/tweaks_detector_rail.png | Bin .../recipes/tweaks_dispenser_without_bow.png | Bin .../boring_smp/recipes/tweaks_powered_rail.png | Bin .../mods}/boring_smp/recipes/tweaks_rail.png | Bin .../mods}/boring_smp/recipes/warp_stone.png | Bin {mods => docs/mods}/brewery/index.md | 0 {mods => docs/mods}/goml/index.md | 0 {mods => docs/mods}/goml/recipes/angelic_aura.png | Bin {mods => docs/mods}/goml/recipes/chaos_zone.png | Bin .../mods}/goml/recipes/crystal_claim_anchor.png | Bin .../mods}/goml/recipes/crystal_upgrade_kit.png | Bin .../mods}/goml/recipes/emeradic_claim_anchor.png | Bin .../mods}/goml/recipes/emeradic_upgrade_kit.png | Bin {mods => docs/mods}/goml/recipes/ender_binding.png | Bin .../mods}/goml/recipes/explosion_controller.png | Bin .../mods}/goml/recipes/glistening_claim_anchor.png | Bin .../mods}/goml/recipes/glistening_upgrade_kit.png | Bin {mods => docs/mods}/goml/recipes/goggles.png | Bin {mods => docs/mods}/goml/recipes/greeter.png | Bin {mods => docs/mods}/goml/recipes/heaven_wings.png | Bin .../mods}/goml/recipes/lake_spirit_grace.png | Bin .../mods}/goml/recipes/makeshift_claim_anchor.png | Bin {mods => docs/mods}/goml/recipes/pvp_arena.png | Bin .../mods}/goml/recipes/reinforced_claim_anchor.png | Bin .../mods}/goml/recipes/reinforced_upgrade_kit.png | Bin {mods => docs/mods}/goml/recipes/village_core.png | Bin .../mods}/goml/recipes/withered_claim_anchor.png | Bin .../mods}/goml/recipes/withered_upgrade_kit.png | Bin {mods => docs/mods}/goml/recipes/withering_seal.png | Bin {mods => docs/mods}/universal_shops/index.md | 0 .../mods}/universal_shops/recipes/trade_block.png | Bin mkdocs.yml | 1 + 40 files changed, 7 insertions(+), 3 deletions(-) rename README.md => docs/index.md (53%) rename {mods => docs/mods}/boring_smp/index.md (99%) rename {mods => docs/mods}/boring_smp/recipes/diamond_from_shards.png (100%) rename {mods => docs/mods}/boring_smp/recipes/diamond_shard_from_diamonds.png (100%) rename {mods => docs/mods}/boring_smp/recipes/tweaks_activator_rail.png (100%) rename {mods => docs/mods}/boring_smp/recipes/tweaks_bundle_from_leather.png (100%) rename {mods => docs/mods}/boring_smp/recipes/tweaks_bundle_from_rabbit_hide.png (100%) rename {mods => docs/mods}/boring_smp/recipes/tweaks_detector_rail.png (100%) rename {mods => docs/mods}/boring_smp/recipes/tweaks_dispenser_without_bow.png (100%) rename {mods => docs/mods}/boring_smp/recipes/tweaks_powered_rail.png (100%) rename {mods => docs/mods}/boring_smp/recipes/tweaks_rail.png (100%) rename {mods => docs/mods}/boring_smp/recipes/warp_stone.png (100%) rename {mods => docs/mods}/brewery/index.md (100%) rename {mods => docs/mods}/goml/index.md (100%) rename {mods => docs/mods}/goml/recipes/angelic_aura.png (100%) rename {mods => docs/mods}/goml/recipes/chaos_zone.png (100%) rename {mods => docs/mods}/goml/recipes/crystal_claim_anchor.png (100%) rename {mods => docs/mods}/goml/recipes/crystal_upgrade_kit.png (100%) rename {mods => docs/mods}/goml/recipes/emeradic_claim_anchor.png (100%) rename {mods => docs/mods}/goml/recipes/emeradic_upgrade_kit.png (100%) rename {mods => docs/mods}/goml/recipes/ender_binding.png (100%) rename {mods => docs/mods}/goml/recipes/explosion_controller.png (100%) rename {mods => docs/mods}/goml/recipes/glistening_claim_anchor.png (100%) rename {mods => docs/mods}/goml/recipes/glistening_upgrade_kit.png (100%) rename {mods => docs/mods}/goml/recipes/goggles.png (100%) rename {mods => docs/mods}/goml/recipes/greeter.png (100%) rename {mods => docs/mods}/goml/recipes/heaven_wings.png (100%) rename {mods => docs/mods}/goml/recipes/lake_spirit_grace.png (100%) rename {mods => docs/mods}/goml/recipes/makeshift_claim_anchor.png (100%) rename {mods => docs/mods}/goml/recipes/pvp_arena.png (100%) rename {mods => docs/mods}/goml/recipes/reinforced_claim_anchor.png (100%) rename {mods => docs/mods}/goml/recipes/reinforced_upgrade_kit.png (100%) rename {mods => docs/mods}/goml/recipes/village_core.png (100%) rename {mods => docs/mods}/goml/recipes/withered_claim_anchor.png (100%) rename {mods => docs/mods}/goml/recipes/withered_upgrade_kit.png (100%) rename {mods => docs/mods}/goml/recipes/withering_seal.png (100%) rename {mods => docs/mods}/universal_shops/index.md (100%) rename {mods => docs/mods}/universal_shops/recipes/trade_block.png (100%) create mode 100644 mkdocs.yml diff --git a/.gitignore b/.gitignore index 24c4fee..11a468d 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ .notes +site diff --git a/README.md b/docs/index.md similarity index 53% rename from README.md rename to docs/index.md index f575004..c8e0624 100644 --- a/README.md +++ b/docs/index.md @@ -1,7 +1,9 @@ -# Boring SMP Wiki +# Boring SMP + +For full documentation visit [mkdocs.org](https://www.mkdocs.org). ## Mods -- [Boring SMP Mod](./mods/boring_smp/index.md) +- [Boring SMP](./mods/boring_smp/index.md) - [Brewery](./mods/brewery/index.md) - [Get Off My Lawn](./mods/goml/index.md) - [Universal Shops](./mods/universal_shops/index.md) diff --git a/mods/boring_smp/index.md b/docs/mods/boring_smp/index.md similarity index 99% rename from mods/boring_smp/index.md rename to docs/mods/boring_smp/index.md index 61a9405..056d267 100644 --- a/mods/boring_smp/index.md +++ b/docs/mods/boring_smp/index.md @@ -1,4 +1,4 @@ -# Boring SMP Mod +# Boring SMP ## Warp Stone The Warp Stone item can be used to teleport to Lodestones. It works very similar to a compass, that can be bound to a Lodestone. You can bind a Warp Stone to a Lodestone by right clicking, and then always teleport back to the Lodestone. In case the Lodestone gets removed, your Warp Stone will no longer work. diff --git a/mods/boring_smp/recipes/diamond_from_shards.png b/docs/mods/boring_smp/recipes/diamond_from_shards.png similarity index 100% rename from mods/boring_smp/recipes/diamond_from_shards.png rename to docs/mods/boring_smp/recipes/diamond_from_shards.png diff --git a/mods/boring_smp/recipes/diamond_shard_from_diamonds.png b/docs/mods/boring_smp/recipes/diamond_shard_from_diamonds.png similarity index 100% rename from mods/boring_smp/recipes/diamond_shard_from_diamonds.png rename to docs/mods/boring_smp/recipes/diamond_shard_from_diamonds.png diff --git a/mods/boring_smp/recipes/tweaks_activator_rail.png b/docs/mods/boring_smp/recipes/tweaks_activator_rail.png similarity index 100% rename from mods/boring_smp/recipes/tweaks_activator_rail.png rename to docs/mods/boring_smp/recipes/tweaks_activator_rail.png diff --git a/mods/boring_smp/recipes/tweaks_bundle_from_leather.png b/docs/mods/boring_smp/recipes/tweaks_bundle_from_leather.png similarity index 100% rename from mods/boring_smp/recipes/tweaks_bundle_from_leather.png rename to docs/mods/boring_smp/recipes/tweaks_bundle_from_leather.png diff --git a/mods/boring_smp/recipes/tweaks_bundle_from_rabbit_hide.png b/docs/mods/boring_smp/recipes/tweaks_bundle_from_rabbit_hide.png similarity index 100% rename from mods/boring_smp/recipes/tweaks_bundle_from_rabbit_hide.png rename to docs/mods/boring_smp/recipes/tweaks_bundle_from_rabbit_hide.png diff --git a/mods/boring_smp/recipes/tweaks_detector_rail.png b/docs/mods/boring_smp/recipes/tweaks_detector_rail.png similarity index 100% rename from mods/boring_smp/recipes/tweaks_detector_rail.png rename to docs/mods/boring_smp/recipes/tweaks_detector_rail.png diff --git a/mods/boring_smp/recipes/tweaks_dispenser_without_bow.png b/docs/mods/boring_smp/recipes/tweaks_dispenser_without_bow.png similarity index 100% rename from mods/boring_smp/recipes/tweaks_dispenser_without_bow.png rename to docs/mods/boring_smp/recipes/tweaks_dispenser_without_bow.png diff --git a/mods/boring_smp/recipes/tweaks_powered_rail.png b/docs/mods/boring_smp/recipes/tweaks_powered_rail.png similarity index 100% rename from mods/boring_smp/recipes/tweaks_powered_rail.png rename to docs/mods/boring_smp/recipes/tweaks_powered_rail.png diff --git a/mods/boring_smp/recipes/tweaks_rail.png b/docs/mods/boring_smp/recipes/tweaks_rail.png similarity index 100% rename from mods/boring_smp/recipes/tweaks_rail.png rename to docs/mods/boring_smp/recipes/tweaks_rail.png diff --git a/mods/boring_smp/recipes/warp_stone.png b/docs/mods/boring_smp/recipes/warp_stone.png similarity index 100% rename from mods/boring_smp/recipes/warp_stone.png rename to docs/mods/boring_smp/recipes/warp_stone.png diff --git a/mods/brewery/index.md b/docs/mods/brewery/index.md similarity index 100% rename from mods/brewery/index.md rename to docs/mods/brewery/index.md diff --git a/mods/goml/index.md b/docs/mods/goml/index.md similarity index 100% rename from mods/goml/index.md rename to docs/mods/goml/index.md diff --git a/mods/goml/recipes/angelic_aura.png b/docs/mods/goml/recipes/angelic_aura.png similarity index 100% rename from mods/goml/recipes/angelic_aura.png rename to docs/mods/goml/recipes/angelic_aura.png diff --git a/mods/goml/recipes/chaos_zone.png b/docs/mods/goml/recipes/chaos_zone.png similarity index 100% rename from mods/goml/recipes/chaos_zone.png rename to docs/mods/goml/recipes/chaos_zone.png diff --git a/mods/goml/recipes/crystal_claim_anchor.png b/docs/mods/goml/recipes/crystal_claim_anchor.png similarity index 100% rename from mods/goml/recipes/crystal_claim_anchor.png rename to docs/mods/goml/recipes/crystal_claim_anchor.png diff --git a/mods/goml/recipes/crystal_upgrade_kit.png b/docs/mods/goml/recipes/crystal_upgrade_kit.png similarity index 100% rename from mods/goml/recipes/crystal_upgrade_kit.png rename to docs/mods/goml/recipes/crystal_upgrade_kit.png diff --git a/mods/goml/recipes/emeradic_claim_anchor.png b/docs/mods/goml/recipes/emeradic_claim_anchor.png similarity index 100% rename from mods/goml/recipes/emeradic_claim_anchor.png rename to docs/mods/goml/recipes/emeradic_claim_anchor.png diff --git a/mods/goml/recipes/emeradic_upgrade_kit.png b/docs/mods/goml/recipes/emeradic_upgrade_kit.png similarity index 100% rename from mods/goml/recipes/emeradic_upgrade_kit.png rename to docs/mods/goml/recipes/emeradic_upgrade_kit.png diff --git a/mods/goml/recipes/ender_binding.png b/docs/mods/goml/recipes/ender_binding.png similarity index 100% rename from mods/goml/recipes/ender_binding.png rename to docs/mods/goml/recipes/ender_binding.png diff --git a/mods/goml/recipes/explosion_controller.png b/docs/mods/goml/recipes/explosion_controller.png similarity index 100% rename from mods/goml/recipes/explosion_controller.png rename to docs/mods/goml/recipes/explosion_controller.png diff --git a/mods/goml/recipes/glistening_claim_anchor.png b/docs/mods/goml/recipes/glistening_claim_anchor.png similarity index 100% rename from mods/goml/recipes/glistening_claim_anchor.png rename to docs/mods/goml/recipes/glistening_claim_anchor.png diff --git a/mods/goml/recipes/glistening_upgrade_kit.png b/docs/mods/goml/recipes/glistening_upgrade_kit.png similarity index 100% rename from mods/goml/recipes/glistening_upgrade_kit.png rename to docs/mods/goml/recipes/glistening_upgrade_kit.png diff --git a/mods/goml/recipes/goggles.png b/docs/mods/goml/recipes/goggles.png similarity index 100% rename from mods/goml/recipes/goggles.png rename to docs/mods/goml/recipes/goggles.png diff --git a/mods/goml/recipes/greeter.png b/docs/mods/goml/recipes/greeter.png similarity index 100% rename from mods/goml/recipes/greeter.png rename to docs/mods/goml/recipes/greeter.png diff --git a/mods/goml/recipes/heaven_wings.png b/docs/mods/goml/recipes/heaven_wings.png similarity index 100% rename from mods/goml/recipes/heaven_wings.png rename to docs/mods/goml/recipes/heaven_wings.png diff --git a/mods/goml/recipes/lake_spirit_grace.png b/docs/mods/goml/recipes/lake_spirit_grace.png similarity index 100% rename from mods/goml/recipes/lake_spirit_grace.png rename to docs/mods/goml/recipes/lake_spirit_grace.png diff --git a/mods/goml/recipes/makeshift_claim_anchor.png b/docs/mods/goml/recipes/makeshift_claim_anchor.png similarity index 100% rename from mods/goml/recipes/makeshift_claim_anchor.png rename to docs/mods/goml/recipes/makeshift_claim_anchor.png diff --git a/mods/goml/recipes/pvp_arena.png b/docs/mods/goml/recipes/pvp_arena.png similarity index 100% rename from mods/goml/recipes/pvp_arena.png rename to docs/mods/goml/recipes/pvp_arena.png diff --git a/mods/goml/recipes/reinforced_claim_anchor.png b/docs/mods/goml/recipes/reinforced_claim_anchor.png similarity index 100% rename from mods/goml/recipes/reinforced_claim_anchor.png rename to docs/mods/goml/recipes/reinforced_claim_anchor.png diff --git a/mods/goml/recipes/reinforced_upgrade_kit.png b/docs/mods/goml/recipes/reinforced_upgrade_kit.png similarity index 100% rename from mods/goml/recipes/reinforced_upgrade_kit.png rename to docs/mods/goml/recipes/reinforced_upgrade_kit.png diff --git a/mods/goml/recipes/village_core.png b/docs/mods/goml/recipes/village_core.png similarity index 100% rename from mods/goml/recipes/village_core.png rename to docs/mods/goml/recipes/village_core.png diff --git a/mods/goml/recipes/withered_claim_anchor.png b/docs/mods/goml/recipes/withered_claim_anchor.png similarity index 100% rename from mods/goml/recipes/withered_claim_anchor.png rename to docs/mods/goml/recipes/withered_claim_anchor.png diff --git a/mods/goml/recipes/withered_upgrade_kit.png b/docs/mods/goml/recipes/withered_upgrade_kit.png similarity index 100% rename from mods/goml/recipes/withered_upgrade_kit.png rename to docs/mods/goml/recipes/withered_upgrade_kit.png diff --git a/mods/goml/recipes/withering_seal.png b/docs/mods/goml/recipes/withering_seal.png similarity index 100% rename from mods/goml/recipes/withering_seal.png rename to docs/mods/goml/recipes/withering_seal.png diff --git a/mods/universal_shops/index.md b/docs/mods/universal_shops/index.md similarity index 100% rename from mods/universal_shops/index.md rename to docs/mods/universal_shops/index.md diff --git a/mods/universal_shops/recipes/trade_block.png b/docs/mods/universal_shops/recipes/trade_block.png similarity index 100% rename from mods/universal_shops/recipes/trade_block.png rename to docs/mods/universal_shops/recipes/trade_block.png diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..128cd89 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1 @@ +site_name: Boring SMP