home-manager/modules/programs/tealdeer.nix
Emily 36a53d9f26 treewide: convert all option docs to Markdown
This process was automated by [my fork of `nix-doc-munge`]. All
conversions were automatically checked to produce the same DocBook
result when converted back, modulo minor typographical/formatting
differences on the acceptable-to-desirable spectrum.

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 \
    {} +
  $ ./format

[my fork of `nix-doc-munge`]: https://github.com/emilazy/nix-doc-munge/tree/home-manager
2023-07-17 18:40:56 +01:00

54 lines
1.2 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.programs.tealdeer;
tomlFormat = pkgs.formats.toml { };
configDir = if pkgs.stdenv.isDarwin then
"Library/Application Support"
else
config.xdg.configHome;
in {
meta.maintainers = [ ];
options.programs.tealdeer = {
enable = mkEnableOption (lib.mdDoc "Tealdeer");
settings = mkOption {
type = tomlFormat.type;
default = { };
defaultText = literalExpression "{ }";
example = literalExpression ''
{
display = {
compact = false;
use_pager = true;
};
updates = {
auto_update = false;
};
};
'';
description = lib.mdDoc ''
Configuration written to
{file}`$XDG_CONFIG_HOME/tealdeer/config.toml` on Linux or
{file}`$HOME/Library/Application Support/tealdeer/config.toml`
on Darwin. See
<https://dbrgn.github.io/tealdeer/config.html>
for more information.
'';
};
};
config = mkIf cfg.enable {
home.packages = [ pkgs.tealdeer ];
home.file."${configDir}/tealdeer/config.toml" = mkIf (cfg.settings != { }) {
source = tomlFormat.generate "tealdeer-config" cfg.settings;
};
};
}