docs: add status to beta/deprecated version links

(cherry picked from commit aef7b53)

Author: MattSturgeon

.github/workflows/website.yml

@@ -63,12 +63,12 @@ jobs:
                 | {
                     "branch": .value.branch,
                     "nixpkgsBranch": .value.channel,
-                    "baseHref": "/nixvim/\(.key)/"
+                    "baseHref": "/nixvim/\(.key)/",
+                    "status": .value.status
                   }
                 | select(.branch == "main").baseHref = "/nixvim/"
               ]
             ' version-info.toml
-            # TODO: add channel status
 
   build:
     name: Build ${{ matrix.name }}

docs/mdbook/book.toml

@@ -8,7 +8,7 @@ title = "nixvim docs"
 [output.html]
 site-url = "@SITE_URL@"
 additional-js = ["theme/pagetoc.js"]
-additional-css = ["theme/pagetoc.css"]
+additional-css = ["custom.css", "theme/pagetoc.css"]
 
 [output.html.fold]
 enable = true

docs/mdbook/custom.css

@@ -0,0 +1,19 @@
+.label {
+  padding: 0.1rem 0.4em;
+  font-size: 0.8em;
+  font-weight: 600;
+  vertical-align: bottom;
+  background-color: #5a6165;
+  text-shadow: rgba(0, 0, 0, 0.25) 0px -1px 0px;
+  -webkit-border-radius: 3px;
+  -moz-border-radius: 3px;
+  border-radius: 3px;
+}
+
+.label-info {
+  background-color: #337798;
+}
+
+.label-warning {
+  background-color: #da8206;
+}

docs/mdbook/default.nix

@@ -10,7 +10,7 @@
   # The root directory of the site
   baseHref ? "/",
   # A list of all available docs that should be linked to
-  # Each element should contain { branch; nixpkgsBranch; baseHref; }
+  # Each element should contain { branch; nixpkgsBranch; baseHref; status; }
   availableVersions ? [ ],
 }:
 let
@@ -305,9 +305,9 @@ let
   # Zip the list of attrs into an attr of lists, for use as bash arrays
   zippedVersions =
     assert lib.assertMsg
-      (lib.all (o: o ? branch && o ? nixpkgsBranch && o ? baseHref) availableVersions)
+      (lib.all (o: o ? branch && o ? nixpkgsBranch && o ? baseHref && o ? status) availableVersions)
       ''
-        Expected all "availableVersions" docs entries to contain { branch, nixpkgsBranch, baseHref } attrs!
+        Expected all "availableVersions" docs entries to contain { branch, nixpkgsBranch, baseHref, status } attrs!
       '';
     lib.zipAttrs availableVersions;
 in
@@ -337,9 +337,10 @@ pkgs.stdenv.mkDerivation (finalAttrs: {
         { type, hasExt, ... }:
         type == "regular"
         && lib.any hasExt [
+          "css"
+          "js"
           "md"
           "toml"
-          "js"
         ]
       ) ./.)
     ];
@@ -428,6 +429,7 @@ pkgs.stdenv.mkDerivation (finalAttrs: {
           branches = zippedVersions.branch or [ ];
           nixpkgsBranches = zippedVersions.nixpkgsBranch or [ ];
           baseHrefs = zippedVersions.baseHref or [ ];
+          statuses = zippedVersions.status or [ ];
           current = baseHref;
         }
         ''
@@ -437,6 +439,7 @@ pkgs.stdenv.mkDerivation (finalAttrs: {
             nixpkgs="''${nixpkgsBranches[i]}"
             baseHref="''${baseHrefs[i]}"
             linkText="\`$branch\` branch"
+            status="''${statuses[i]}"
 
             link=
             suffix=
@@ -448,7 +451,25 @@ pkgs.stdenv.mkDerivation (finalAttrs: {
               link="[$linkText]($baseHref)"
             fi
 
-            echo "- The $link, for use with nixpkgs \`$nixpkgs\`$suffix" >> "$out"
+            statusClass=
+            statusText=
+            if [ "$status" = "beta" ]; then
+              statusClass="label label-info"
+              statusText=Beta
+            elif [ "$status" = "deprecated" ]; then
+              statusClass="label label-warning"
+              statusText=Deprecated
+            fi
+
+            {
+              echo -n '- '
+              if [ -n "$statusClass" ] && [ -n "$statusText" ]; then
+                echo -n '<span class="'"$statusClass"'">'"$statusText"'</span> '
+              fi
+              echo -n "The $link"
+              echo -n ", for use with nixpkgs \`$nixpkgs\`"
+              echo "$suffix"
+            } >> "$out"
           done
         '';
     user-configs = callPackage ../user-configs { };