9f9e277b60
These (and the `*MD` functions apart from `literalMD`) are now no-ops
in nixpkgs and serve no purpose other than to add additional noise and
potentially mislead people into thinking unmarked DocBook documentation
will still be accepted.
Note that if backporting changes including documentation to 23.05,
the `mdDoc` calls will need to be re-added.
To reproduce this commit, run:
$ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \
nix shell nixpkgs#coreutils \
-c find . -name '*.nix' \
-exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \
--strip {} +
$ ./format
81 lines
2.2 KiB
Nix
81 lines
2.2 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
|
|
cfg = config.programs.sioyek;
|
|
|
|
renderConfig = generators.toKeyValue {
|
|
mkKeyValue = key: value: "${key} ${value}";
|
|
listsAsDuplicateKeys = true;
|
|
};
|
|
|
|
in {
|
|
options = {
|
|
programs.sioyek = {
|
|
enable = mkEnableOption
|
|
"Sioyek, a PDF viewer designed for reading research papers and technical books";
|
|
|
|
package = mkOption {
|
|
default = pkgs.sioyek;
|
|
defaultText = literalExpression "pkgs.sioyek";
|
|
type = types.package;
|
|
description = "Package providing the sioyek binary";
|
|
};
|
|
|
|
bindings = mkOption {
|
|
description = ''
|
|
Input configuration written to
|
|
{file}`$XDG_CONFIG_HOME/sioyek/keys_user.config`.
|
|
See <https://github.com/ahrm/sioyek/blob/main/pdf_viewer/keys.config>.
|
|
|
|
Each attribute could also accept a list of strings to set multiple
|
|
bindings of the same command.
|
|
'';
|
|
type = with types; attrsOf (either str (listOf str));
|
|
default = { };
|
|
example = literalExpression ''
|
|
{
|
|
"move_up" = "k";
|
|
"move_down" = "j";
|
|
"move_left" = "h";
|
|
"move_right" = "l";
|
|
"screen_down" = [ "d" "<C-d>" ];
|
|
"screen_up" = [ "u" "<C-u>" ];
|
|
}
|
|
'';
|
|
};
|
|
|
|
config = mkOption {
|
|
description = ''
|
|
Input configuration written to
|
|
{file}`$XDG_CONFIG_HOME/sioyek/prefs_user.config`.
|
|
See <https://github.com/ahrm/sioyek/blob/main/pdf_viewer/prefs.config>.
|
|
'';
|
|
type = types.attrsOf types.str;
|
|
default = { };
|
|
example = literalExpression ''
|
|
{
|
|
"background_color" = "1.0 1.0 1.0";
|
|
"text_highlight_color" = "1.0 0.0 0.0";
|
|
}
|
|
'';
|
|
};
|
|
|
|
};
|
|
};
|
|
|
|
config = mkIf cfg.enable (mkMerge [
|
|
{ home.packages = [ cfg.package ]; }
|
|
(mkIf (cfg.config != { }) {
|
|
xdg.configFile."sioyek/prefs_user.config".text = renderConfig cfg.config;
|
|
})
|
|
(mkIf (cfg.bindings != { }) {
|
|
xdg.configFile."sioyek/keys_user.config".text = renderConfig cfg.bindings;
|
|
})
|
|
]);
|
|
|
|
meta.maintainers = [ hm.maintainers.podocarp ];
|
|
}
|