feat: add mkdocs-awesome-pages-plugin

base.yml

@@ -26,6 +26,10 @@ markdown_extensions:
       alternate_style: true
   - pymdownx.tasklist
 
+plugins:
+  - search
+  - awesome-pages
+
 theme:
   name: 'material'
   palette:

default.nix

@@ -5,12 +5,13 @@ in
 pkgs.runCommand "mkdocs"
 {
   buildInputs = [
+    mkdocs-markdownextradata-plugin
     pkgs.mkdocs
     pkgs.python3Packages.cairosvg
+    pkgs.python3Packages.mkdocs-awesome-pages-plugin
     pkgs.python3Packages.mkdocs-material
     pkgs.python3Packages.mkdocs-redirects
     pkgs.python3Packages.pillow
-    mkdocs-markdownextradata-plugin
   ];
 } ''
   mkdir -p $out/bin

docs/index.md

@@ -1,4 +1,5 @@
-# NumTide Material for MkDocs base repo
+# Numtide Material for MkDocs base repo
+
 
 For full documentation visit [mkdocs-material](https://squidfunk.github.io/mkdocs-material/getting-started/).
 

flake.nix

@@ -1,6 +1,8 @@
 {
   description = "mkdocs-numtide";
 
+  inputs.nixpkgs.url = "github:NixOS/nixpkgs?ref=nixos-unstable";
+
   outputs = { self, nixpkgs }:
     let
       eachSystem = f:

mkdocs.yml

@@ -2,8 +2,10 @@ INHERIT: !ENV MKDOCS_NUMTIDE_THEME
 
 ### Site metadata ###
 
+
+
 ## - This will be the name displayed in docs header
-site_name: NumTide custom docs
+site_name: Numtide custom docs
 ## - change this according to the relevant Numtide repo description
 site_description: Custom MkDocs base Repo
 ## - change this according to the relevant Numtide repo docs location - eg https://numtide.github.io/treefmt/