wiki-tui 0.5.0 - Docs.rs

wiki-tui-0.5.0 is not a library.

Visit the last successful build: wiki-tui-0.9.2

Note: wiki-tui is still under active development and breaking changes can occur. Please always check the release notes before upgrading

Preview

How it looks

Note: These Screenshots were taken on iTerm2 (MacOS) with the Fira Code font

Usage

Please refer to wiki-tui --help for more information on cli arguments.

Note: when searching for an article or opening one, please wait while the program fetches the results

Controls

Installation

The binary executable is wiki-tui

Cargo

cargo install wiki-tui

When installing wiki-tui via cargo, you can choose what backend to use (The default one is crossterm). More information on the available backends can be found here

To use a different backend, you will have to disable the default features and enable the desired backend feature.

cargo install wiki-tui --no-default-features --features termion-backend

NetBSD

Using the package manager

pkgin install wiki-tui

Building from source

cd /usr/pkgsrc/www/wiki-tui
make install

Nix

The wiki-tui package is in the nixpkgs package repository.

Either install it with nix-env -iA wiki-tui, get it temporarily with nix-shell -p wiki-tui or add it to your configuration.

AUR

The wiki-tui package is available in the AUR.

Either install it with makepkg manually, or using the preferred AUR helper.

Configuration

Location of the config file

MacOS, Linux and NetBSD

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

Windows

C:\Users\{USERNAME}\wiki-tui\config.toml

Settings

Default configuration

[api]
base_url = "https://en.wikipedia.org/"  # this is the url of wikipedia, it can be changed to change the language of wikipedia 

# The settings here are all colors and can be set by either the name of the color or a hex string (valid formats are: #ffffff, #fff)
# The actual colors displayed in your terminal can change depending on your terminal settings

[theme]
background = "white"                    # color used for View backgrounds
title = "red"                           # color used for the title text
highlight = "red"                       # color used for highlighting text
highlight_inactive = "blue"             # color used for highlighting inactive text
highlight_text = "white"                # color used for highlighted text
text = "black"                          # color used for the text
search_match = "red"                    # color used for a search match in the results view

# You can also change the theme of specific views
# These settings are the same for every supported view
[theme.search_bar]
background = "white"
title = "red"
highlight = "red"
highlight_inactive = "blue"
highlight_text = "white"
text = "black"

# Currently, these views are supported:
# - search_bar
# - search_results
# - search_preview
# - article_view
# - toc_view

[logging]
enabled = true                          # can be either true or false. enables/disables logging
log_dir = "wiki_tui.log"                # location of the file where the log will be written to
log_level = "Info"                      # log level to be used, can be Debug, Info, Warn, Error

# wiki-tui allows you to disable certain features like links completely.
# All features are enabled by default
[features]
links = true                            # enables/disables links (link selection, link opening, etc)
toc = true                          # enables/disables the table of contents

# You can change the keybindings of certain actions
# These are the default values
[keybindings]
down.key = ""
# Here you can define the key, it can be a simple character or a non-character key
# Supported non-character Keys (lower-/uppercase do not matter):
# - insert
# - delete
# - home
# - end
# - pageup
# - pagedown
# - pausebreak
# - numpadcenter
# - f0 - f12

down.mode = "normal"
# Here you can change the mode of the keybinding. The standard mode is normal and doesn't need to be set.
# This value is optional and the following modes are available:
# Characters:
# - normal
# - ctrl
# Non-Character Keys:
# - normal
# - shift
# - alt
# - altshift
# - ctrl
# - ctrlshift
# - ctrlalt


# Currently, these actions can be changed with a keybinding:
# - down
# - up
# - left
# - right

# Note: the default keys (Up, Down, Left, Right) will still work even after changing the keybinding.

Contributing

See contributing guidelines for contributing conventions.

Similar Projects

Acknowledgements

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!