refs #147: Added support to front matter sorting, plus navigation sor…

…ted.

Dockerfile

@@ -0,0 +1,3 @@
+FROM minidocks/mkdocs:latest
+
+RUN pip install mkdocs-nav-weight

docker-compose.yml

@@ -6,5 +6,7 @@ services:
         working_dir: /app
         labels:
             - com.dnsdock.alias=docs.popochiu.loc
-        image: minidocks/mkdocs
-        command: serve -a 0.0.0.0:80 -t readthedocs
+        build:
+            context: .
+            dockerfile: Dockerfile
+        command: serve -a 0.0.0.0:80

docs/docs/the-engine-handbook/advanced-techniques/advanced-animations.md → docs/content/advanced-techniques/advanced-animations.md

@@ -1,3 +1,7 @@
+---
+weight: 5030
+---
+
 ## Animation prefixes
 
 TODO

docs/content/advanced-techniques/extending-customizing-popochiu.md

@@ -0,0 +1,5 @@
+---
+weight: 5050
+---
+
+TODO

docs/content/advanced-techniques/game-state-saving-loading.md

@@ -0,0 +1,5 @@
+---
+weight: 5040
+---
+
+TODO

docs/docs/the-engine-handbook/advanced-techniques/guis.md → docs/content/advanced-techniques/guis.md

@@ -1,3 +1,7 @@
+---
+weight: 5020
+---
+
 ## Theming your GUI
 
 TODO

docs/content/advanced-techniques/index.md

@@ -0,0 +1,3 @@
+---
+weight: 5000
+---

docs/content/advanced-techniques/localization.md

@@ -0,0 +1,5 @@
+---
+weight: 5010
+---
+
+TODO

docs/docs/contributing-to-popochiu/coding-standards.md → docs/content/contributing-to-popochiu/coding-standards.md

@@ -1,3 +1,7 @@
+---
+weight: 7040
+---
+
 ## Commit format
 
 TODO

docs/content/contributing-to-popochiu/getting-help.md

@@ -0,0 +1,15 @@
+---
+weight: 7050
+---
+
+## How to contact maintainers
+
+TODO
+
+## Channels
+
+TODO
+
+## Other policies
+
+TODO

docs/content/contributing-to-popochiu/index.md

@@ -0,0 +1,4 @@
+---
+weight: 7000
+empty: true
+---

docs/docs/contributing-to-popochiu/project-management.md → docs/content/contributing-to-popochiu/project-management.md

@@ -1,3 +1,7 @@
+---
+weight: 7030
+---
+
 ## Issue tracking
 
 TODO

docs/docs/contributing-to-popochiu/project-overview.md → docs/content/contributing-to-popochiu/project-overview.md

@@ -1,3 +1,7 @@
+---
+weight: 7000
+---
+
 ## Popochiu Subsystems
 
 TODO

docs/docs/contributing-to-popochiu/toolchain-and-dependencies.md → docs/content/contributing-to-popochiu/toolchain-and-dependencies.md

@@ -1,3 +1,7 @@
+---
+weight: 7020
+---
+
 ## Documentation
 
 TODO

docs/docs/getting-started/creating-a-game-stub.md → docs/content/getting-started/creating-a-game-stub.md

@@ -1,3 +1,7 @@
+---
+weight: 1020
+---
+
 This page will guide you trought the process of creating a very small stub for a game.
 
 The purpose of this page is to quickly get you set up to experiment and tinker as you read this documentation. If you are already familiar with Popochiu or have already created your project, you can skip to the [Tutorials](/getting-started/tutorials) section.

docs/docs/getting-started/example-resources.md → docs/content/getting-started/example-resources.md

@@ -1,3 +1,7 @@
+---
+weight: 1030
+---
+
 Everything you need to start creating your adventure game with Popochiu, beside the addon, is a good idea, assets and the game script.
 
 When working on a new project, Popochiu will set the project up for you but other than that, it will provide you with a blank slate so that you don't need to clean the stage from unwanted stuff.

docs/docs/getting-started/getting-help.md → docs/content/getting-started/getting-help.md

@@ -1,3 +1,7 @@
+---
+weight: 1050
+---
+
 ## Join our community
 
 We do our best to keep this documentation relevant and up to date, but we know that there are nuances and needs that will go beyond what we can provide.

docs/content/getting-started/index.md

@@ -0,0 +1,4 @@
+---
+weight: 1000
+empty: true
+---

docs/docs/getting-started/installing-popochiu.md → docs/content/getting-started/installing-popochiu.md

@@ -1,4 +1,9 @@
-Popochiu works on Godot 3.3 and later versions, but we recommend kickstarting new projects on Godot 4, with Popochiu 2.0.
+---
+weight: 1010
+---
+
+!!! tip
+      Popochiu works on Godot 3.3 and later versions, but we recommend kickstarting new projects on Godot 4, with Popochiu 2.0.
 
 ## Get Godot
 

docs/docs/getting-started/tutorials.md → docs/content/getting-started/tutorials.md

@@ -1,3 +1,7 @@
+---
+weight: 1040
+---
+
 ## Tutorials
 
 TODO

docs/content/how-to-develop-a-game/adding-sound.md

@@ -0,0 +1,5 @@
+---
+weight: 4080
+---
+
+TODO

docs/content/how-to-develop-a-game/creating-characters.md

@@ -0,0 +1,5 @@
+---
+weight: 4030
+---
+
+TODO

docs/content/how-to-develop-a-game/creating-rooms.md

@@ -0,0 +1,5 @@
+---
+weight: 4020
+---
+
+TODO

docs/content/how-to-develop-a-game/index.md

@@ -0,0 +1,4 @@
+---
+weight: 4000
+empty: true
+---

docs/content/how-to-develop-a-game/kickstarting-a-project.md

@@ -0,0 +1,5 @@
+---
+weight: 4010
+---
+
+TODO

docs/content/how-to-develop-a-game/managing-the-inventory.md

@@ -0,0 +1,5 @@
+---
+weight: 4060
+---
+
+TODO

docs/content/how-to-develop-a-game/playing-animations.md

@@ -0,0 +1,5 @@
+---
+weight: 4070
+---
+
+TODO

docs/content/how-to-develop-a-game/scripting-interactions.md

@@ -0,0 +1,5 @@
+---
+weight: 4040
+---
+
+TODO

docs/content/how-to-develop-a-game/writing-dialogues.md

@@ -0,0 +1,5 @@
+---
+weight: 4050
+---
+
+TODO

docs/docs/index.md → docs/content/index.md

@@ -1,3 +1,7 @@
+---
+weight: 0
+---
+
 ![Popochiu itch.io](./_assets/images/getting_started-itch_cover.png)
 
 **Popochiu is a Godot addon that allows you to create point-and-click adventure games.**

docs/docs/the-editor-handbook/editor-settings.md → docs/content/the-editor-handbook/editor-settings.md

@@ -1 +1,5 @@
+---
+weight: 2010
+---
+
 TODO: how to reach the editor settings and set them up

docs/docs/the-editor-handbook/tools/aseprite-importers.md → docs/content/the-editor-handbook/importers.md

@@ -1,3 +1,7 @@
+---
+weight: 2050
+---
+
 # Aseprite Importers
 
 These tools enable a smooth workflow for the creation of graphical elements in the game.  
@@ -23,7 +27,7 @@ Let's see examples for both.
 
 Please take a look at the following image:
 
-![Character Aseprite source file example](../../_assets/images/aseprite_importer-source_file_example-character.png "Aseprite source file example - Character")
+![Character Aseprite source file example](../_assets/images/aseprite_importer-source_file_example-character.png "Aseprite source file example - Character")
 
 First notable thing is, a single file contains all animations for the character, identified by tags (_marker 1_). Each tag will be used to create a single animation, named after the tag, for the Character.
 
@@ -34,17 +38,17 @@ Your file can also be organized in layers (_marker 2_). Layer names are complete
 
 Layers are particularly useful in Rooms source files, because without them, isolating props tend to become pretty messy. Take a look at the following example.
 
-![Room Aseprite source file example](../../_assets/images/aseprite_importer-source_file_example-room-1.png "Aseprite source file example - Room")
+![Room Aseprite source file example](../_assets/images/aseprite_importer-source_file_example-room-1.png "Aseprite source file example - Room")
 
 To keep different props apart, the image is organized in layers (_marker 1_). In the specific case, layer names and tag names match, but you can of course have situations where more than one layer is necessary to render a specific tag (it's pretty common really); a typical example is the background: in the example above, we could have decided to have the trees on the background prop. The resulting Aseprite file would have looked like this then:
 
-![Room Aseprite source file example - Joined layers](../../_assets/images/aseprite_importer-source_file_example-room-3.png "Aseprite source file example - Multi-layer background")
+![Room Aseprite source file example - Joined layers](../_assets/images/aseprite_importer-source_file_example-room-3.png "Aseprite source file example - Multi-layer background")
 
 Notice how the _Tree_ tag disappeared and the _Tree layer_ is now present with the _Background_ one in the _Background_ tag.
 
 On the other hand, you can have tags with many frames on the same layer. This is the most common case because you often wants your props to be animated, like in the case of our crackling bonefire (see _marker 2_ in the image above):
 
-![Room Aseprite source file example - Multi frame animation](../../_assets/images/aseprite_importer-source_file_example-room-2.png "Aseprite source file example - Multi-frame animation")
+![Room Aseprite source file example - Multi frame animation](../_assets/images/aseprite_importer-source_file_example-room-2.png "Aseprite source file example - Multi-frame animation")
 
 Here we have an isolated fire, composed by 4 frames, all grouped by the proper tag.
 
@@ -97,7 +101,7 @@ The Aseprite Importer exposes its configuration under the **Popochiu -> Import**
 
 Editor Settings contain those configurations that may change between team members' local development environment, like the Aseprite command path, and/or that are valid across different projects.
 
-![Editor Settings](../../_assets/images/aseprite_importer-settings-es.png "Editor Settings")
+![Editor Settings](../_assets/images/aseprite_importer-settings-es.png "Editor Settings")
 
 * **Enable Aseprite Importer**: Allows the user to enable or disable the importer in their editor. Useful to avoid cluttering the inspector or getting errors for those who don't use Aseprite or don't have it available in a specific environment.
 > !!! note
@@ -113,7 +117,7 @@ Anyway, the plugin will check for the correct execution of the command before in
 
 Among the Project Settings you'll find those you may want to share with your team, and that mostly impact the importing workflow, setting defaults shared by every instance of the plugin.
 
-![Project Settings](../../_assets/images/aseprite_importer-settings-ps.png "Project Settings")
+![Project Settings](../_assets/images/aseprite_importer-settings-ps.png "Project Settings")
 
 !!! note
     Since Godot 4, Project Settings have an "Advanced Settings" filter. Plugins can't declare their settings as _basic_, so please make sure you have the upper left toggle _activated_ or you won't see Popochiu's settings section.
@@ -134,13 +138,13 @@ The following sections show examples for both Characters and Rooms, highlighting
 
 The Character importer tool is visible in the inspector, when you select a [PopochiuCharacter](./PopochiuCharacter.md) object, opening the related scene.
 
-![Character Aseprite importer](../../_assets/images/aseprite_importer-activate_importer-character.png "Character Aseprite importer")
+![Character Aseprite importer](../_assets/images/aseprite_importer-activate_importer-character.png "Character Aseprite importer")
 
 You will not see the importer when you select a character instance in a specific room. To see the importer, you must open the character scene and select its root node.
 
 Likewise, a Room importer is shown in the Room inspector, when you select the root node of an open Room scene.
 
-![Room Aseprite importer](../../_assets/images/aseprite_importer-activate_importer-room.png "Room Aseprite importer")
+![Room Aseprite importer](../_assets/images/aseprite_importer-activate_importer-room.png "Room Aseprite importer")
 
 !!! note
     If any error occurs when the plugin starts (for example if there are problems with the Aseprite command or missing dependencies in the scene tree), a warning will be visualized in place of the plugin. Head to the Output Panel to learn how to fix the error.
@@ -152,15 +156,15 @@ Likewise, a Room importer is shown in the Room inspector, when you select the ro
 
 When you select a [PopochiuCharacter](./PopochiuCharacter.md) node, you should see this interface in the node inspector, right after the script variables section:
 
-![Character Aseprite Importer interface](../../_assets/images/aseprite_importer-importer_interface-character.png "Character Aseprite importer interface")
+![Character Aseprite Importer interface](../_assets/images/aseprite_importer-importer_interface-character.png "Character Aseprite importer interface")
 
 Use **Aseprite file** field (_1_) to select the source file. When you do this, the plugin automatically scans the file and lists every tag found (_2_) (or none if the file is a single animation with no tags).
 
 For each tag that is found and listed, two flags are available (_3_): **Import this animation** and **Set the animation as looping**. Deactivating them can prevent a specific animation to be imported or set the animation as a single-run.
 
 For [PopochiuRoom](./PopochiuRoom.md) node, the interface is only slightly different, showing two more flags for each tag (_1_ below):
 
-![Room Aseprite Importer interface](../../_assets/images/aseprite_importer-importer_interface-room-diff.png "Room Aseprite importer interface differences")
+![Room Aseprite Importer interface](../_assets/images/aseprite_importer-importer_interface-room-diff.png "Room Aseprite importer interface differences")
 
 **This prop will be visible** and **This prop will be clickable** flags will make the imported prop visible and interactive, respectively.
 

docs/content/the-editor-handbook/index.md

@@ -0,0 +1,5 @@
+---
+weight: 2000
+empty: true
+---
+

docs/docs/the-editor-handbook/interface-overview.md → docs/content/the-editor-handbook/interface-overview.md

@@ -1,3 +1,7 @@
+---
+weight: 2010
+---
+
 ## Editor Settings
 
 TODO

docs/docs/the-editor-handbook/popochiu-dock.md → docs/content/the-editor-handbook/popochiu-dock.md

@@ -1,3 +1,7 @@
+---
+weight: 2020
+---
+
 ![Popochiu dock](./_assets/images/getting_started-popochiu_dock.png)
 
 The Popochiu dock consists of different tabs, used to group the objects that build the game.

docs/docs/the-editor-handbook/toolbar-buttons.md → docs/content/the-editor-handbook/toolbar-buttons.md

@@ -1,3 +1,7 @@
+---
+weight: 2030
+---
+
 TODO: all differet toolbar buttons by popochiu object
 
 ## Character

docs/content/the-engine-handbook/index.md

@@ -0,0 +1,4 @@
+---
+weight: 3000
+empty: true
+---

docs/docs/the-engine-handbook/scripting-overview.md → docs/content/the-engine-handbook/scripting-overview.md

@@ -1,3 +1,7 @@
+---
+weight: 3010
+---
+
 ## Singletons
 
 TODO

docs/content/the-engine-handbook/scripting-reference/index.md

@@ -0,0 +1,5 @@
+---
+weight: 3020
+empty: true
+---
+