docs: update nixmkdocs, use svg logo, add style.css, set site_url

This commit is contained in:
technofab 2025-09-25 20:35:37 +02:00
parent 8dccb9a9a8
commit 76c6d39100
No known key found for this signature in database
6 changed files with 42 additions and 70 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

1
docs/images/logo.svg Normal file
View file

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" width="240" height="240" fill="none"><rect width="240" height="240" fill="#fff" rx="27"/><path fill="#FC6D26" d="m120.7 159.2 46.4 37.5c3.3 2.6 6.6 4.6 11.2 4.6h1.3l3 5.3-6.2 10.8h-12.8l-20.8-36.2-30-.1-12.7-21.9h20.6Zm89.2 0-12.4 22h-3.8a25 25 0 0 0-.6-1.7v-.1l-8.4-20.2h25.2ZM41 178.2l-12.8-21.6L43 131H13.7l-6.3-10.9 6.4-11.1 41.8.1 15-25.9H96l-54.8 95ZM149 48l14.7-25.4h12.6l6.4 11-21 36.2 14.9 26-10.6 18.5-27.2-65.3c-2.2-6-8-9.7-14-9.6-2 0-3.8.3-5.5 1l-10.2-17.7 25.3-.3L149 48Z"/><path fill="url(#a)" d="m120.7 159.2 46.4 37.5c3.3 2.6 6.6 4.6 11.2 4.6h1.3l3 5.3-6.2 10.8h-12.8l-20.8-36.2-30-.1-12.7-21.9h20.6Zm89.2 0-12.4 22h-3.8a25 25 0 0 0-.6-1.7v-.1l-8.4-20.2h25.2ZM41 178.2l-12.8-21.6L43 131H13.7l-6.3-10.9 6.4-11.1 41.8.1 15-25.9H96l-54.8 95ZM149 48l14.7-25.4h12.6l6.4 11-21 36.2 14.9 26-10.6 18.5-27.2-65.3c-2.2-6-8-9.7-14-9.6-2 0-3.8.3-5.5 1l-10.2-17.7 25.3-.3L149 48Z"/><path fill="#E24329" d="m103.6 170 27.4 47.4-25.2.3L91 192l-14.7 25.4H63.9l-6.5-11 3.6-6.2h20l1.4-3.8 15-37.3 6.2 10.7Zm-25.3-43.8-10.6 25.4-4.2-7.2 12.6-22 2.2 3.8Zm133.4-42.8L197 109h29.3l6.3 10.9-6.4 11h-41.8l-6.7 11.5L167 117l31.8-55.2 12.8 21.7ZM97.1 58.6h9.3l-9 22H30l12.4-22H72L57.3 33.3l6.2-10.8h12.8l20.8 36.2Z"/><path fill="url(#b)" d="m103.6 170 27.4 47.4-25.2.3L91 192l-14.7 25.4H63.9l-6.5-11 3.6-6.2h20l1.4-3.8 15-37.3 6.2 10.7Zm-25.3-43.8-10.6 25.4-4.2-7.2 12.6-22 2.2 3.8Zm133.4-42.8L197 109h29.3l6.3 10.9-6.4 11h-41.8l-6.7 11.5L167 117l31.8-55.2 12.8 21.7ZM97.1 58.6h9.3l-9 22H30l12.4-22H72L57.3 33.3l6.2-10.8h12.8l20.8 36.2Z"/><path fill="#000" d="m106.8 119.6 53.3 42-35.4-87-18 45Zm81.6 66.3a9.7 9.7 0 0 1-10 9.4c-2.6 0-4.7-1-7.5-3.3l-70.4-56.8-23.6 59.1H56.4l59.7-143.2a9 9 0 0 1 8.7-5.8 8.6 8.6 0 0 1 8.4 5.8l54.3 130.6c.5 1.3 1 2.6 1 4v.2Z"/><defs><linearGradient id="a" x1="181.2" x2="141" y1="114.6" y2="45.1" gradientUnits="userSpaceOnUse"><stop stop-color="#699AD7"/><stop offset=".2" stop-color="#7EB1DD"/><stop offset="1" stop-color="#7EBAE4"/></linearGradient><linearGradient id="b" x1="151.1" x2="191.8" y1="167.7" y2="98.7" gradientUnits="userSpaceOnUse"><stop stop-color="#415E9A"/><stop offset=".2" stop-color="#4A6BAF"/><stop offset="1" stop-color="#5277C3"/></linearGradient></defs></svg>

After

Width:  |  Height:  |  Size: 2.2 KiB

15
docs/style.css Normal file
View file

@ -0,0 +1,15 @@
.md-header__button.md-logo {
margin: 0;
padding-top: .2rem;
padding-bottom: .2rem;
}
[dir="ltr"] .md-header__title {
margin-left: 0;
}
.md-header__button.md-logo img,
.md-header__button.md-logo svg {
height: 2rem;
}

7
flake.lock generated
View file

@ -230,17 +230,16 @@
"nix-mkdocs": {
"locked": {
"dir": "lib",
"lastModified": 1754753501,
"narHash": "sha256-k7KEGQ7qejmwrSXVSvZ9zVD1H+ZtNm0I5fmCVmZVi+4=",
"lastModified": 1757055638,
"narHash": "sha256-KHYSkEreFe4meXzSdEbknC/HwaQSNClQkc8vzHlAsMM=",
"owner": "technofab",
"repo": "nixmkdocs",
"rev": "aba4f26f320b15043101824b65e72058ecab296f",
"rev": "7840a5febdbeaf2da90babf6c94b3d0929d2bf74",
"type": "gitlab"
},
"original": {
"dir": "lib",
"owner": "technofab",
"ref": "v1.0.0",
"repo": "nixmkdocs",
"type": "gitlab"
}

View file

@ -39,56 +39,36 @@
convco.enable = true;
};
};
doc = {
docs."default".config = {
path = ./docs;
deps = pp: [
pp.mkdocs-material
pp.mkdocs-macros
(pp.callPackage inputs.mkdocs-material-umami {})
];
material = {
enable = true;
colors = {
primary = "black";
accent = "blue";
};
umami = {
enable = true;
src = "https://analytics.tf/umami";
siteId = "d8354dfa-2ad2-4089-90d2-899b981aef22";
domains = ["nixible.projects.tf"];
};
};
macros = {
enable = true;
includeDir = toString self'.packages.optionsDocs;
};
config = {
site_name = "Nixible";
site_url = "https://nixible.projects.tf";
repo_name = "TECHNOFAB/nixible";
repo_url = "https://gitlab.com/TECHNOFAB/nixible";
edit_uri = "edit/main/docs/";
extra_css = ["style.css"];
theme = {
name = "material";
features = ["content.code.copy" "content.action.edit"];
icon.repo = "simple/gitlab";
logo = "images/logo.png";
favicon = "images/favicon.png";
palette = [
{
scheme = "default";
media = "(prefers-color-scheme: light)";
primary = "black";
accent = "blue";
toggle = {
icon = "material/brightness-7";
name = "Switch to dark mode";
};
}
{
scheme = "slate";
media = "(prefers-color-scheme: dark)";
primary = "black";
accent = "blue";
toggle = {
icon = "material/brightness-4";
name = "Switch to light mode";
};
}
];
logo = "images/logo.svg";
favicon = "images/logo.svg";
};
plugins = [
"search"
"material-umami"
{
macros = {
include_dir = self'.packages.optionsDocs;
};
}
];
nav = [
{"Introduction" = "index.md";}
{"Usage" = "usage.md";}
@ -100,29 +80,6 @@
"pymdownx.superfences"
"admonition"
];
extra.analytics = {
provider = "umami";
site_id = "d8354dfa-2ad2-4089-90d2-899b981aef22";
src = "https://analytics.tf/umami";
domains = "nixible.projects.tf";
feedback = {
title = "Was this page helpful?";
ratings = [
{
icon = "material/thumb-up-outline";
name = "This page is helpful";
data = "good";
note = "Thanks for your feedback!";
}
{
icon = "material/thumb-down-outline";
name = "This page could be improved";
data = "bad";
note = "Thanks for your feedback! Please leave feedback by creating an issue :)";
}
];
};
};
};
};
ci = {
@ -227,7 +184,7 @@
treefmt-nix.url = "github:numtide/treefmt-nix";
nix-gitlab-ci.url = "gitlab:technofab/nix-gitlab-ci?dir=lib";
nixtest.url = "gitlab:technofab/nixtest?dir=lib";
nix-mkdocs.url = "gitlab:technofab/nixmkdocs/v1.0.0?dir=lib";
nix-mkdocs.url = "gitlab:technofab/nixmkdocs?dir=lib";
mkdocs-material-umami.url = "gitlab:technofab/mkdocs-material-umami";
};