Add docs

.github/workflows/docs.yaml

@@ -1,3 +1,4 @@
+# by https://github.com/danth/stylix/blob/master/.github/workflows/docs.yml
 name: Docs
 
 on:

docs/default.nix

@@ -1,7 +1,22 @@
+# with friendly help by stylix: https://github.com/danth/stylix/blob/master/docs/default.nix
 { pkgs, build_systems, ... }:
 
 let
-  makeOptionsDoc = configuration: pkgs.nixosOptionsDoc { inherit (configuration) options lib; };
+  makeOptionsDoc =
+    configuration:
+    pkgs.nixosOptionsDoc {
+      inherit (configuration) options;
+
+      # Filter out any options not beginning with `stylix`
+      transformOptions =
+        option:
+        option
+        // {
+          visible =
+            option.visible
+            && (builtins.elemAt option.loc 0 == "conf" || builtins.elemAt option.loc 0 == "mods");
+        };
+    };
   example = makeOptionsDoc (build_systems [ "example" ] ../example/.)."example";
 in
 pkgs.stdenvNoCC.mkDerivation {

docs/src/SUMMARY.md

@@ -0,0 +1,2 @@
+[Options](dashNix.md)
+

docs/src/dashNix.md

@@ -1 +0,0 @@
-pingpang

result

@@ -1 +1 @@
-/nix/store/hpbdpm0knf560f4igq5yc6c6nvap7s65-dashNix-book
+/nix/store/0fpgnkzjnwbjykdvbk4p2h3c7isb9sz9-dashNix-book