Merge pull request 'add formatter, update readme, update site on change to the config' (#25) from mkdocs-wiki into main

Reviewed-on: #25

.forgejo/workflows/build.yaml

@@ -8,6 +8,7 @@ on:
       - flake.*
       - src/**/*
       - .forgejo/**/*
+      - mkdocs.yml
 
 jobs:
   # Build it locally, this helps caching for later

README.md

@@ -1,16 +1,7 @@
-# skynet.ie-renew
+# Skynet Wiki
-Webpage explaining membership options to Alumni members.  
+[Wiki for Skynet][1]
 
-## Previous version
+Uses [mkdocs][2] to generate the site.  
-This repo originally lived at <https://github.com/ULCompSoc/skynet.ie-renew>.  
-It lived at <https://skynet.ie/renew>.  
-It used a cron job and [this script][1] to keep it updated.
 
-## Current version 
+[1]: https://wiki.skynet.ie
-Now it is living at <https://renew.skynet.ie> with a pipeline to automatically update it.
+[2]: https://www.mkdocs.org
-
-
-
-
-
-[1]: https://gitlab.skynet.ie/compsoc1/skynet/website/alumni-renew/-/blob/5d1dd98bf6cc33be275c28f8fb6871fb10e8f687/update-renew-from-github.sh

flake.lock

@@ -1,12 +1,86 @@
 {
   "nodes": {
+    "alejandra": {
+      "inputs": {
+        "fenix": "fenix",
+        "flakeCompat": "flakeCompat",
+        "nixpkgs": "nixpkgs"
+      },
+      "locked": {
+        "lastModified": 1719514321,
+        "narHash": "sha256-ys1nJdZ8zB8JlpUbQmnj0hZalg03bEPgQdZN30DhETE=",
+        "owner": "kamadorueda",
+        "repo": "alejandra",
+        "rev": "d7552fef2ccf1bbf0d36b27f6fddb19073f205b7",
+        "type": "github"
+      },
+      "original": {
+        "owner": "kamadorueda",
+        "repo": "alejandra",
+        "type": "github"
+      }
+    },
+    "fenix": {
+      "inputs": {
+        "nixpkgs": [
+          "alejandra",
+          "nixpkgs"
+        ],
+        "rust-analyzer-src": "rust-analyzer-src"
+      },
+      "locked": {
+        "lastModified": 1668234453,
+        "narHash": "sha256-FmuZThToBvRsqCauYJ3l8HJoGLAY5cMULeYEKIaGrRw=",
+        "owner": "nix-community",
+        "repo": "fenix",
+        "rev": "8f219f6b36e8d0d56afa7f67e6e3df63ef013cdb",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-community",
+        "repo": "fenix",
+        "type": "github"
+      }
+    },
+    "flakeCompat": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1650374568,
+        "narHash": "sha256-Z+s0J8/r907g149rllvwhb4pKi8Wam5ij0st8PwAh+E=",
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "rev": "b4a34015c698c7793d592d66adbab377907a2be8",
+        "type": "github"
+      },
+      "original": {
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "type": "github"
+      }
+    },
     "nixpkgs": {
       "locked": {
-        "lastModified": 1724300212,
+        "lastModified": 1668226844,
-        "narHash": "sha256-x3jl6OWTs+L9C7EtscuWZmGZWI0iSBDafvg3X7JMa1A=",
+        "narHash": "sha256-G/S4FBWDAqHeBS/hfXwUCJbnaKnrQFoeeKwzvZEOgxM=",
+        "owner": "nixos",
+        "repo": "nixpkgs",
+        "rev": "dd4767bf613bf9553eee6ff37c0996b9c876e7d8",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nixos",
+        "ref": "nixos-unstable-small",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs_2": {
+      "locked": {
+        "lastModified": 1724395761,
+        "narHash": "sha256-zRkDV/nbrnp3Y8oCADf5ETl1sDrdmAW6/bBVJ8EbIdQ=",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "4de4818c1ffa76d57787af936e8a23648bda6be4",
+        "rev": "ae815cee91b417be55d43781eb4b73ae1ecc396c",
         "type": "github"
       },
       "original": {
@@ -16,10 +90,28 @@
     },
     "root": {
       "inputs": {
-        "nixpkgs": "nixpkgs",
+        "alejandra": "alejandra",
+        "nixpkgs": "nixpkgs_2",
         "utils": "utils"
       }
     },
+    "rust-analyzer-src": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1668182250,
+        "narHash": "sha256-PYGaOCiFvnJdVz+ZCaKF8geGdffXjJUNcMwaBHv0FT4=",
+        "owner": "rust-lang",
+        "repo": "rust-analyzer",
+        "rev": "45ec315e01dc8dd1146dfeb65f0ef6e5c2efed78",
+        "type": "github"
+      },
+      "original": {
+        "owner": "rust-lang",
+        "ref": "nightly",
+        "repo": "rust-analyzer",
+        "type": "github"
+      }
+    },
     "systems": {
       "locked": {
         "lastModified": 1681028828,
@@ -40,11 +132,11 @@
         "systems": "systems"
       },
       "locked": {
-        "lastModified": 1694529238,
+        "lastModified": 1710146030,
-        "narHash": "sha256-zsNZZGTGnMOf9YpHKJqMSsa0dXbfmxeoJ7xHlrt+xmY=",
+        "narHash": "sha256-SZ5L6eA7HJ/nmkzGG7/ISclqe6oZdOZTNoesiInkXPQ=",
         "owner": "numtide",
         "repo": "flake-utils",
-        "rev": "ff7b65b44d01cf9ba6a71320833626af21126384",
+        "rev": "b1d9ab70662946ef0850d488da1c9019f3a9752a",
         "type": "github"
       },
       "original": {

flake.nix

@@ -3,31 +3,37 @@
 
   inputs = {
     utils.url = "github:numtide/flake-utils";
+    alejandra.url = "github:kamadorueda/alejandra";
   };
 
-  outputs = { self, nixpkgs, utils, }: utils.lib.eachDefaultSystem (system:
+  outputs = {
-    let
+    self,
-      pkgs = nixpkgs.legacyPackages."${system}";
+    nixpkgs,
+    utils,
+    alejandra,
+  }:
+    utils.lib.eachDefaultSystem (
+      system: let
+        pkgs = nixpkgs.legacyPackages."${system}";
+        # find these here https://search.nixos.org/packages?channel=unstable&from=0&size=50&sort=relevance&type=packages&query=python312Packages.mkdocs
+        packages = with pkgs.python3Packages; [
+          mkdocs
+          mkdocs-material
+        ];
+      in {
+        formatter = alejandra.defaultPackage.${system};
+        defaultPackage = pkgs.stdenv.mkDerivation {
+          name = "skynet-wiki";
+          src = self;
+          buildInputs = packages;
+          buildPhase = "mkdocs build";
+          installPhase = "mkdir -p $out; cp -R site/* $out;";
+        };
 
-      # find these here https://search.nixos.org/packages?channel=unstable&from=0&size=50&sort=relevance&type=packages&query=python312Packages.mkdocs
+        devShells.default = pkgs.mkShell {
-      packages = with pkgs.python3Packages; [
+          name = "Skynet Wiki env";
-        mkdocs
+          packages = packages;
-        mkdocs-material
+        };
-      ];
+      }
-
+    );
-    in {
-      defaultPackage = pkgs.stdenv.mkDerivation {
-        name = "skynet-wiki";
-        src = self;
-        buildInputs = packages;
-        buildPhase = "mkdocs build";
-        installPhase = "mkdir -p $out; cp -R site/* $out;";
-      };
-
-      devShells.default = pkgs.mkShell {
-        name = "Skynet Wiki env";
-        packages = packages;
-      };
-    }
-  );
 }