Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

programs.tealdeer.enable

Whether to enable Tealdeer.

Type: boolean

Default:

false

Example:

true

Declared by:

programs.tealdeer.enableAutoUpdates

Whether to enable Auto updates.

Type: boolean

Default:

true

Example:

false

Declared by:

programs.tealdeer.package

The tealdeer package to use.

Type: package

Default:

pkgs.tealdeer

Declared by:

programs.tealdeer.settings

Configuration written to $XDG_CONFIG_HOME/tealdeer/config.toml on Linux or $HOME/Library/Application Support/tealdeer/config.toml on Darwin. See https://tealdeer-rs.github.io/tealdeer/config.html for more information.

Type: null or (open submodule of (TOML value))

Default:

null

Example:

{
  display = {
    compact = false;
    use_pager = true;
  };
  updates = {
    auto_update = false;
  };
};

Declared by:

programs.tealdeer.settings.updates

Tealdeer can refresh the cache automatically when it is outdated. This behavior can be configured in the updates section.

Type: open submodule of (TOML value)

Default:

{ }

Declared by:

programs.tealdeer.settings.updates.auto_update

Whether to enable auto-update.

Type: boolean

Default:

false

Example:

true

Declared by:

programs.tealdeer.settings.updates.auto_update_interval_hours

Duration, since the last cache update, after which the cache will be refreshed. This parameter is ignored if auto_update is set to false.

Type: positive integer, meaning >0

Default:

720

Example:

24

Declared by: