Skip to content

Theme Settings

The configuration file of the theme can be found in WIKI_TUI_CONFIG/theme.toml

Usually it's this path:

$HOME/.config/wiki-tui/theme.toml

But you can also verify the path using wiki-tui --theme-config-path

Warning

The actual colors displayed in your terminal can change depending on your terminal settings

About Colors

All colors from the ANSI color table are supported (though some names are not exactly the same).

Color Name Foreground Background
black 30 40
red 31 41
green 32 42
yellow 33 43
blue 34 44
magenta 35 45
cyan 36 46
gray 37 47
darkgray 90 100
lightred 91 101
lightgreen 92 102
lightyellow 93 103
lightblue 94 104
lightmagenta 95 105
lightcyan 96 106
white 97 107

RGB Color

We also support RGB colors, but note that only terminals that support 24-bit true color will display this correctly. Notably versions of Windows Terminal prior to Windows 10 and macOS Terminal.app do not support this.

8-Bit 256 Indexed

Indexed 8-bit colors are also supported, see https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit for more information about them.

Further Information about Color parsing

This section of the documentation was taken mostly from the ratatui::style::Color documentation. If you want to see exactly how the colors are being parsed, you can check ratatui's implementation here

Theme

Background

0.9.0 Default: reset

The color used for the view backgrounds

bg = "reset"

Foreground

0.9.0 Default: reset

The color used for the foreground, mainly the color of the text

fg = "reset"

Title

0.9.0 Default: white

The color is used for the title of the borders

title = "white"

Search Title

0.9.0 Default: red

The color for the titles in the search results

search_title_fg = "red"

Selected Items

0.9.0 Default: darkgray | reset

The colors used for the foreground and background of selected items (eg. in lists)

selected_bg = "darkgray"
selected_fg = "reset"

Inactive

0.9.0 Default: blue

The color is used for inactive items (eg. inactive text)

inactive_fg = "blue"

Highlight

0.9.0 Default: white

The color is used for the highlighted items (eg. text)

highlight_fg = "white"

Scrollbar

0.9.0 Default: black | blue

The colors used for the thumb and track of scrollbars

scrollbar_track_fg = "black"
scrollbar_thumb_fg = "blue"

Statusbar

0.9.0 Default: reset | darkgray

The colors used for the statusbar in the search and page panes

status_bar_fg = "reset"
status_bar_bg = "darkgray"

Configure the borders

Colors

0.9.0 Default: white | reset

The colors used for the foreground and background of the borders

border_fg = "white"
border_bg = "reset"

Border Type

0.9.0 Default: Rounded

Warning

Depending on your font, some border styles may differ from the examples below

You can change the look of the borders in wiki-tui. Available styles are:

  • Plain
  • Rounded
  • Double
  • Thick
  • QuadrantInside
  • QuadrantOutside
border_type = "Rounded"

More information about the characters for the borders can be found on ratatui's documentation on the BorderType here