docs: add initial docs base

This commit is contained in:
technofab 2025-08-27 11:22:26 +02:00
parent af1494f3c6
commit ed75ed6695
Signed by: technofab
SSH key fingerprint: SHA256:bV4h88OqS/AxjbPn66uUdvK9JsgIW4tv3vwJQ8tpMqQ
8 changed files with 124 additions and 13 deletions

63
nix/repo/docs.nix Normal file
View file

@ -0,0 +1,63 @@
{inputs, ...}: let
inherit (inputs) pkgs soonix doclib;
optionsDoc = doclib.mkOptionDocs {
module = soonix.module;
roots = [
{
url = "https://gitlab.com/TECHNOFAB/soonix/-/blob/main/lib";
path = "${inputs.self}/lib";
}
];
};
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;
umami = {
enable = true;
src = "https://analytics.tf/umami";
siteId = "e8b0ca9c-c540-41b0-8eb8-1b2fcc5e57f7";
domains = ["soonix.projects.tf"];
};
};
macros = {
enable = true;
includeDir = toString optionsDocs;
};
config = {
site_name = "Soonix";
repo_name = "TECHNOFAB/soonix";
repo_url = "https://gitlab.com/TECHNOFAB/soonix";
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;
}

18
nix/repo/flake.lock generated
View file

@ -17,6 +17,23 @@
"type": "gitlab"
}
},
"nixmkdocs": {
"locked": {
"dir": "lib",
"lastModified": 1755785622,
"narHash": "sha256-xBb9PCkszmrWSEqUiPC7oBJABm1thF572S5QHtloZ+M=",
"owner": "TECHNOFAB",
"repo": "nixmkdocs",
"rev": "61da605a9bff12f66c4b743f43aea59ca200f533",
"type": "gitlab"
},
"original": {
"dir": "lib",
"owner": "TECHNOFAB",
"repo": "nixmkdocs",
"type": "gitlab"
}
},
"nixtest-lib": {
"locked": {
"dir": "lib",
@ -37,6 +54,7 @@
"root": {
"inputs": {
"devshell-lib": "devshell-lib",
"nixmkdocs": "nixmkdocs",
"nixtest-lib": "nixtest-lib"
}
}

View file

@ -2,12 +2,14 @@
inputs = {
devshell-lib.url = "gitlab:rensa-nix/devshell?dir=lib";
nixtest-lib.url = "gitlab:TECHNOFAB/nixtest?dir=lib";
nixmkdocs.url = "gitlab:TECHNOFAB/nixmkdocs?dir=lib";
};
outputs = i:
i
// {
ntlib = i.nixtest-lib.lib {inherit (i.parent) pkgs;};
devshell = i.devshell-lib.lib {inherit (i.parent) pkgs;};
doclib = i.nixmkdocs.lib {inherit (i.parent) pkgs;};
soonix = import "${i.parent.self}/lib" {inherit (i.parent) pkgs;};
};
}