chore: add initial nixmkdocs setup and improve documentation (695d36a4) · Commits · Rensa / DevShell

.envrc

+1 −1

source $(fetchurl https://gitlab.com/rensa-nix/direnv/-/raw/v0.2.0/direnvrc "sha256-PFFxlZWNz/LLuNHA1Zpu2qdC3MF+oukv/TxFj5Utixk=")

source $(fetchurl https://gitlab.com/rensa-nix/direnv/-/raw/v0.3.0/direnvrc "sha256-u7+KEz684NnIZ+Vh5x5qLrt8rKdnUNexewBoeTcEVHQ=")

use ren //repo/devShells/default

0 → 100644

+2 −0

Original line number	Diff line number	Diff line
		result

0 → 100644

+68 −0

Original line number	Diff line number	Diff line
		{inputs, ...}: let
		inherit (inputs) pkgs devshell doclib;

		roots = [
		{
		url = "https://gitlab.com/rensa-nix/devshell/-/blob/main/lib";
		path = "${inputs.self}/lib";
		}
		];
		optionsDoc = doclib.mkOptionDocs {
		module = devshell.modules;
		inherit roots;
		};
		optionsDocs = pkgs.runCommand "options-docs" {} ''
		mkdir -p $out
		ln -s ${optionsDoc} $out/options.md
		'';
		in
		(doclib.mkDocs {
		docs."default" = {
		base = "${inputs.self}";
		path = "${inputs.self}/docs";
		material = {
		enable = true;
		colors = {
		primary = "aqua";
		accent = "blue";
		};
		umami = {
		enable = false;
		src = "https://analytics.tf/umami";
		siteId = "";
		domains = ["devshell.rensa.projects.tf"];
		};
		};
		macros = {
		enable = true;
		includeDir = toString optionsDocs;
		};
		config = {
		site_name = "Devshell";
		repo_name = "rensa-nix/devshell";
		repo_url = "https://gitlab.com/rensa-nix/devshell";
		theme = {
		logo = "images/logo.png";
		icon.repo = "simple/gitlab";
		favicon = "images/favicon.png";
		};
		nav = [
		{"Introduction" = "index.md";}
		{"Options" = "options.md";}
		];
		markdown_extensions = [
		{
		"pymdownx.highlight".pygments_lang_class = true;
		}
		"pymdownx.inlinehilite"
		"pymdownx.snippets"
		"pymdownx.superfences"
		"pymdownx.escapeall"
		"fenced_code"
		];
		};
		};
		}).packages
		// {
		inherit optionsDocs;
		}

+34 −0

Original line number	Diff line number	Diff line
		{
		"nodes": {
		"mkdocs-material-umami": {
		"locked": {
		"lastModified": 1745840856,
		"narHash": "sha256-1Ad1JTMQMP6YsoIKAA+SBCE15qWrYkGue9/lXOLnu9I=",
		"owner": "technofab",
		"repo": "mkdocs-material-umami",
		"rev": "3ac9b194450f6b779c37b8d16fec640198e5cd0a",
		"type": "gitlab"
		},
		"original": {
		"owner": "technofab",
		"repo": "mkdocs-material-umami",
		"type": "gitlab"
		}
		},
		"nixmkdocs": {
		"locked": {
		"dir": "lib",
		"lastModified": 1755783537,
		"narHash": "sha256-78lWSC3UzkpWYsnyncqbrE37gEIWLzejOeDyoBb6h5o=",
		"owner": "TECHNOFAB",
		"repo": "nixmkdocs",
		"rev": "4fd5a351c54e005c4e8df7e23a8e4eec9d3b8cd1",
		"type": "gitlab"
		},
		"original": {
		"dir": "lib",
		"owner": "TECHNOFAB",
		"repo": "nixmkdocs",
		"type": "gitlab"
		}
		},
		"nixtest-lib": {
		"locked": {
		"dir": "lib",
		@@ -19,6 +51,8 @@
		},
		"root": {
		"inputs": {
		"mkdocs-material-umami": "mkdocs-material-umami",
		"nixmkdocs": "nixmkdocs",
		"nixtest-lib": "nixtest-lib"
		}
		}

+6 −0

Original line number	Diff line number	Diff line
		{
		inputs = {
		nixtest-lib.url = "gitlab:TECHNOFAB/nixtest?dir=lib";
		nixmkdocs.url = "gitlab:TECHNOFAB/nixmkdocs?dir=lib";
		mkdocs-material-umami.url = "gitlab:technofab/mkdocs-material-umami";
		};
		outputs = i:
		i
		// {
		ntlib = i.nixtest-lib.lib {inherit (i.parent) pkgs;};
		doclib = i.nixmkdocs.lib {
		inherit (i.parent) pkgs;
		inherit (i.parent.pkgs) lib;
		};
		devshell = import "${i.parent.self}/lib" {inherit (i.parent) pkgs;};
		};
		}