wiki-tui 0.4.3

Preview

How it looks

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

Usage

If you want to search for an article quickly, you can pass the search term as an argument.

wiki-tui <ARTICLE>

wiki-tui then searches for this article automatically.

Controls

Installation

The binary executable is wiki-tui

Cargo

cargo install wiki-tui

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.

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

# You can disable certain parsing features by setting these values to false
# All features are enabled by default
[parser]
toc = true
headers = true
paragraphs = true
lists = true
code_blocks = true

[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

Contributing

See contributing guidelines for contributing conventions.

Similar Projects

• hexrcs/wiki-cli

Acknowledgements

• cursive
• Some parts of Best-README-Template

Contributors ✨

Thanks goes to these wonderful people (emoji key):

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