diff options
| author | Michelle Tilley <michelle@michelletilley.net> | 2026-01-16 11:09:19 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-01-16 11:09:19 -0800 |
| commit | b70e0d5f56f071c0107750a03db16619124c403e (patch) | |
| tree | f90cf723a773b62fcb8840fc905a10f03c5ec8db /docs | |
| parent | feat(theme): Note new default theme name and syntax (#3080) (diff) | |
| download | atuin-b70e0d5f56f071c0107750a03db16619124c403e.zip | |
feat(ultracompact): Adds setting for ultracompact mode (#3079)
**Migrated from atuinsh/docs PR:**
https://github.com/atuinsh/docs/pull/72
**Original author:** @philtweir
---
### What does this PR do?
Adds the `auto_hide_height` setting to enable/disable/configure
ultracompact mode when fewer than a minimum number of lines are
available and the `compact` style has been configured. The new
keybindings for the inspector are outlined also.
Notes the new `(none)` theme, which will be used for functional
code-tests and as a fallback when the requested theme is unloadable.
Corresponds to: https://github.com/atuinsh/atuin/pull/2319
Co-authored-by: Phil Weir <phil.weir@flaxandteal.co.uk>
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docs/configuration/config.md | 10 | ||||
| -rw-r--r-- | docs/docs/configuration/key-binding.md | 3 | ||||
| -rw-r--r-- | docs/docs/guide/theming.md | 5 |
3 files changed, 18 insertions, 0 deletions
diff --git a/docs/docs/configuration/config.md b/docs/docs/configuration/config.md index 3dcc2aa2..79bf0961 100644 --- a/docs/docs/configuration/config.md +++ b/docs/docs/configuration/config.md @@ -267,6 +267,16 @@ Default: `true` Configure whether or not to show tabs for search and inspect. +### `auto_hide_height` + +Atuin version: >= 18.4 + +Default: `8` + +Set Atuin to hide lines when a minimum number of rows is subceeded. This has no effect except +when `compact` style is being used (see `style` above), and currently applies to only the +interactive search and inspector. It can be turned off entirely by setting to `0`. + ### `exit_mode` Default: `return-original` diff --git a/docs/docs/configuration/key-binding.md b/docs/docs/configuration/key-binding.md index 4a01cd2d..7f57e987 100644 --- a/docs/docs/configuration/key-binding.md +++ b/docs/docs/configuration/key-binding.md @@ -206,3 +206,6 @@ Open the inspector with ctrl-o | Esc | Close the inspector, returning to the shell | | ctrl+o | Close the inspector, returning to search view | | ctrl+d | Delete the inspected item from the history | +| ↑ | Inspect the previous item in the history | +| ↓ | Inspect the next item in the history | +| tab | Select current item and edit | diff --git a/docs/docs/guide/theming.md b/docs/docs/guide/theming.md index 0a59d720..e6c36bdd 100644 --- a/docs/docs/guide/theming.md +++ b/docs/docs/guide/theming.md @@ -20,6 +20,7 @@ Where `THEMENAME` is a known theme. The following themes are available out-of-th * `default` theme * `autumn` theme * `marine` theme +* `(none)` theme (removes all styling) These are present to ensure users and developers can try out theming, but in general, you will need to download themes or make your own. @@ -111,6 +112,10 @@ where not all of the *Meanings* need to be explicitly defined. If they are absen then the color will be chosen from the parent theme, if one is defined, or if that key is missing in the `theme` block, from the `default` theme. +If the entire named theme is missing, which is inherently an error, then the theme +will drop to `(none)` and leave Atuin unstyled, rather than trying to fallback to +the any default, or other, theme. + This theme file should be moved to `~/.config/atuin/themes/my-theme.toml` and the following added to `~/.config/atuin/config.toml`: |