Skip to content

Commit

Permalink
add docs for show_preview_auto (#50)
Browse files Browse the repository at this point in the history
  • Loading branch information
tessus authored Jun 13, 2024
1 parent 01b1a27 commit e185d58
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion src/content/docs/configuration/config.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -513,7 +513,7 @@ atuin dotfiles alias delete k
After setting an alias, you will either need to restart your shell or source the init file for the change to take affect

## keys
This section of client config is specifically for configuring key-related settings.
This section of the client config is specifically for configuring key-related settings.

```toml
[keys]
Expand All @@ -527,6 +527,27 @@ Default: true

Configures whether the TUI exits, when scrolled past the last or first entry.

## preview
This section of the client config is specifically for configuring preview-related settings.
(In the future the other 2 preview settings will be moved here.)

```toml
[preview]
strategy = [...]
```

### `strategy`
Atuin version: >= 18.3

Which preview strategy is used to calculate the preview height. It respects `max_preview_height`.

| Value | Preview height is calculated from the length of the |
|----------------|-----------------------------------------------------|
| auto (default) | selected command |
| static | longest command in the current result set |

By using `auto` a preview is shown, iff the command is longer than the width of the terminal.

## Daemon
Atuin version: >= 18.3

Expand Down

0 comments on commit e185d58

Please sign in to comment.