add members & contributing pages

.github/workflows/build.yml

@@ -2,7 +2,7 @@ name: Build Container
 
 on:
   push:
-    branches: 
+    branches:
       - release
       - main
 
@@ -39,6 +39,7 @@ jobs:
       - name: Build and push Docker image
         uses: docker/build-push-action@v6
         with:
+          file: docker/Dockerfile
           context: .
           push: true
           tags: ${{ steps.meta.outputs.tags }}

.vscode/settings.json

@@ -9,5 +9,6 @@
       "tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg",
       "tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji",
       "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
-   ]
+   ],
+   "editor.formatOnSave": false
 }

README.md

@@ -23,6 +23,10 @@ docs/something/even/elser.md -> /something/even/elser/
 
 ## For Developers
 
+You can run the app locally using only docker & docker-compose using the file `docker/docker-compose.yml`. This will serve the app in dev mode with hot-reloading & everything.
+
+Alternatively you can run it outside of a container using the following instructions.
+
 ### Requirements
 
 - Python 3

docker/docker-compose.yml

@@ -0,0 +1,10 @@
+name: galena-wiki
+
+services:
+  app:
+    image: squidfunk/mkdocs-material:latest
+    volumes:
+      - ../:/docs
+    ports:
+      - 8000:8000
+    entrypoint: ["sh", "docker/setup.sh"]

docker/setup.sh

@@ -0,0 +1,5 @@
+cd /docs
+
+pip install -r requirements.txt
+
+mkdocs serve --dev-addr=0.0.0.0:8000

docs/contributing/index.md

@@ -0,0 +1,113 @@
+---
+hide:
+  - navigation
+  - toc
+---
+
+# Contributing to the Wiki
+
+Every page can be edited by modifing the content of it's respective markdown (`.md`) file.
+You are redirected to the github edit dialog by using the edit button visible on every page on the top-right.
+
+For contributers that are not within the organization, this means that you can create a [Fork](https://github.com/TeamGalena/Wiki/fork) and submit your changes/additions using a Pull-Request.
+
+Pages are located withing the `docs` directory and resolve to the following routes:
+
+```
+docs/index.md -> / (the home page)
+docs/something.md -> /something/
+docs/something/index.md -> /something/
+docs/something/else.md -> /something/else/
+docs/something/even/elser.md -> /something/even/elser/
+```
+
+## Useful snippets
+
+### Links
+
+Links can be created by using the syntax `[link text](link url)`
+
+- [Link to GitHub](https://github.com)
+- [Link a different Page](../members.md)
+- [Link with a tooltip](../index.md "Wow you hovered me!")
+
+```
+- [Link to GitHub](https://github.com)
+- [Link a different Page](../members.md)
+- [Link with a tooltip](../index.md "Wow you hovered me!")
+```
+
+### Images
+
+Images can be embedded simlar to links, just by prefixing them with a `!`
+
+<div class="grid cards" markdown>
+
+-  
+   ```
+   ![](/assets/icon.png)
+   ```
+
+    ![](/assets/icon.png){ width=100 align=right }
+
+    I am a simple image
+
+-   
+   ```
+   ![](/assets/icon.png){ .on-glb }
+   ```
+
+    ![](/assets/icon.png){ .on-glb width=100 align=right }
+
+    You can open me up
+
+-   
+   ```
+   ![](/assets/icon.png){ .inline-icon }
+   ```
+
+    I am an inline icon ![](/assets/icon.png){ .inline-icon } within some text
+
+</div>
+
+Icons of blocks & items can be embedded using the following syntax.
+
+<div class="grid" style="grid-template-columns: 100px 1fr; align-items: center" markdown>
+
+
+![]({{ hosts.icons }}/minecraft/obsidian.png)
+
+```
+![]({​{ hosts.icons }}/minecraft/obsidian.png)
+```
+
+![]({{ hosts.icons }}/oreganized/goopy_lead_block.png)
+
+```
+![]({​{ hosts.icons }}/oreganized/goopy_lead_block.png)
+```
+
+![]({{ hosts.icons }}/windswept/chestnuts.png)
+
+```
+![]({​{ hosts.icons }}/windswept/chestnuts.png)
+```
+
+</div>
+
+[:octicons-search-16: Browse available icons](https://icons.macarena.ceo/browse){ .md-button target="_blank" }
+
+### Admonitions
+
+Admonitions can be created with several types, specific by in the example below by the work `info`.
+You can read about all of them [here](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#supported-types).
+
+
+!!! info "Example admonitions"
+    Here is some content for your admonitions, although this is optional.
+
+
+```
+!!! info "Example admonitions"
+    Here is some content for your admonitions, although this is optional.
+```

docs/index.md

@@ -8,7 +8,7 @@ hide:
 
 !!! example "This wiki is still very much work in progress"
 
-This wiki contains documentation for several mods made by Team Galena
+This wiki contains documentation for several mods made by [Team Galena](members.md "See members").
 
 <div class="grid hotbar cards" markdown>
 

docs/members.md

@@ -0,0 +1,87 @@
+---
+hide:
+  - navigation
+  - toc
+---
+
+# Members
+
+<div class="grid cards hotbar" markdown>
+
+-   @Binome
+
+    ---
+
+    ![](/assets/avatars/binome.jpg){ .avatar }
+
+    In id do reprehenderit consectetur minim excepteur voluptate officia adipisicing veniam dolore esse aliqua.
+
+    ---
+
+    _Artist_{ .chip }
+
+-   @Rose
+
+    ---
+
+    ![](/assets/avatars/rose.png){ .avatar }
+
+    Aliqua non exercitation labore qui incididunt consequat pariatur.
+
+    ---
+
+    _Developer_{ .chip }
+
+-   @Xaidee
+
+    ---
+
+    ![](/assets/avatars/xaidee.png){ .avatar }
+
+    Tempor occaecat id fugiat duis est laboris labore adipisicing sit consequat fugiat non.
+
+    ---
+
+    _Developer_{ .chip }
+
+-   @Yapetto
+
+    ---
+
+    ![](/assets/avatars/yape.png){ .avatar }
+
+    Consectetur commodo sit aute ex ipsum velit culpa consequat fugiat.
+
+    ---
+
+    _Artist_{ .chip }
+
+    <!-- md:extension [attr_list][Attribute Lists] -->
+
+
+-   @Orcinus
+
+    ---
+
+    ![](/assets/avatars/orcinus.png){ .avatar }
+
+    Culpa laboris magna tempor quis eiusmod qui sit laboris aute elit quis.
+
+    ---
+
+    _Developer_{ .chip }
+
+
+-   @PssbleTrngle
+
+    ---
+
+    ![](/assets/avatars/possible_triangle.png){ .avatar }
+
+    Duis anim nulla incididunt cillum nostrud.
+
+    ---
+
+    _Developer_{ .chip }
+
+</div>

docs/oreganized/melting.md

@@ -14,7 +14,7 @@ These molten states of blocks will hurt when standing on them. Some blocks, like
 [lead bars ![]({{ hosts.icons }}/oreganized/lead_bars.png){ .inline-icon }](lead-decoration.md#lead-bars)
 also behave differently based on their heat level.
 
-<div class="grid hotbar" style="max-width: 600px" markdown>
+<div class="grid progress" markdown>
 
 ![Lead Block]({{ hosts.icons }}/oreganized/lead_block.png)
 

docs/styles/extra.css

@@ -15,16 +15,29 @@
   }
 
   .hotbar {
-    grid-auto-flow: column;
-    grid-template-columns: unset;
-
-    align-items: center;
     margin-left: auto;
     margin-right: auto;
 
+    grid-template-columns: repeat(2, 1fr);
+
     p > .twemoji {
       font-size: 1.6rem;
     }
+
+    @media screen and (min-width: 1220px) {
+      grid-auto-flow: column;
+      grid-auto-columns: 1fr;
+      grid-template-columns: unset;
+    }
+  }
+
+  .progress {
+    margin-left: auto;
+    margin-right: auto;
+
+    max-width: 600px;
+    grid-template-columns: repeat(5, auto);
+    align-items: center;
   }
 
   .inline-icon {
@@ -42,4 +55,21 @@
     --md-primary-fg-color: #1bd96a;
     --md-accent-fg-color: #22ff84;
   }
+
+  .avatar {
+    border-radius: 9999px;
+  }
+
+  .chip {
+    background: var(--md-primary-fg-color);
+    border-radius: 9999px;
+    padding: 0.4em 0.8em;
+    cursor: default;
+
+    transition: background 125ms;
+
+    &:hover {
+      background: var(--md-accent-fg-color);
+    }
+  }
 }

mkdocs.yml

@@ -40,6 +40,9 @@ extra:
     - icon: fontawesome/brands/github
       link: https://github.com/TeamGalena
 
+    - icon: fontawesome/brands/twitter
+      link: https://twitter.com/TeamGalena
+
   hosts:
     icons: https://icons.macarena.ceo/icons
 
@@ -70,3 +73,7 @@ extra_css:
   - styles/extra.css
 extra_javascript:
   - scripts/favicon.js
+
+not_in_nav: |
+  /members.md
+  /contributing/**/*.md