diff --git a/base.yml b/base.yml index d8aa7a6..873d05a 100644 --- a/base.yml +++ b/base.yml @@ -26,6 +26,10 @@ markdown_extensions: alternate_style: true - pymdownx.tasklist +plugins: + - search + - awesome-pages + theme: name: 'material' palette: diff --git a/default.nix b/default.nix index cf55b50..19e3feb 100644 --- a/default.nix +++ b/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 diff --git a/docs/index.md b/docs/index.md index 4258d8b..4b2e334 100644 --- a/docs/index.md +++ b/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/). diff --git a/flake.lock b/flake.lock index b9a2f70..ed017e1 100644 --- a/flake.lock +++ b/flake.lock @@ -2,14 +2,18 @@ "nodes": { "nixpkgs": { "locked": { - "lastModified": 0, - "narHash": "sha256-vOuiDPLHSEo/7NkiWtxpHpHgoXoNmrm+wkXZ6a072Fc=", - "path": "/nix/store/2yf8ybi63pc8kjl45d2ll6cg69ch9pv4-source", - "type": "path" + "lastModified": 1722185531, + "narHash": "sha256-veKR07psFoJjINLC8RK4DiLniGGMgF3QMlS4tb74S6k=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "52ec9ac3b12395ad677e8b62106f0b98c1f8569d", + "type": "github" }, "original": { - "id": "nixpkgs", - "type": "indirect" + "owner": "NixOS", + "ref": "nixos-unstable", + "repo": "nixpkgs", + "type": "github" } }, "root": { diff --git a/flake.nix b/flake.nix index 5cecf67..d8a2e2c 100644 --- a/flake.nix +++ b/flake.nix @@ -1,6 +1,8 @@ { description = "mkdocs-numtide"; + inputs.nixpkgs.url = "github:NixOS/nixpkgs?ref=nixos-unstable"; + outputs = { self, nixpkgs }: let eachSystem = f: diff --git a/mkdocs.yml b/mkdocs.yml index 50f5333..7725aef 100644 --- a/mkdocs.yml +++ b/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/