wiki-tui

Crates.iowiki-tui
lib.rswiki-tui
version0.8.2
sourcesrc
created_at2021-10-16 11:41:38.697588
updated_at2023-08-11 09:57:58.848017
descriptionA simple and easy to use Wikipedia Text User Interface
homepage
repositoryhttps://github.com/Builditluc/wiki-tui
max_upload_size
id465823
size561,905
(Builditluc)

documentation

README

Contributors Stargazers Issues MIT license Continuous Integration Continuous Deployment


Logo; wiki-tui entered into a command line prompt

WIKI-TUI

A simple and easy to use Wikipedia Text User Interface

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

You can find the installation instructions, configuration options, more preview images, a feature overview and more on our website, builditluc.github.io/wiki-tui

What can it do?

  • Browse wikipedia in a TUI. Features of the TUI include:

    • Rich search results (result previews, more information on results, continue the current search)
    • Open articles in layers (press ESC to close a layer)
    • A Table of Contents with support for jumping to the section in the article
    • Rich article view (functioning links, lists, headers)
    • Switch the language of an article
  • VIM-like Keybindings:

    • Basic movement
    • Goto Top / Bottom
    • Half up / down
  • It's customizable (we plan on having more features in the future):

    • Change the global and local theme of individual UI components
    • Change some of the keybindings
    • Disable features (Table of Contents, Links)
    • Customize the Table of Contents (position, title format, sizes, etc.)
    • Change wikipedias language (even on the fly)
    • Logging

How it looks

preview-3

Note: This screenshot was taken on iTerm2 (MacOS) with the Fira Code font

Similar Projects

Acknowledgements

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Builditluc
Builditluc

🤔 💻 📖 🐛
0323pin
0323pin

🐛 📦
legendofmiracles
legendofmiracles

📦
Thomas
Thomas

📦 🐛
Nuno Teixeira
Nuno Teixeira

📦
cshjsc
cshjsc

💻
Dmitry Kozlovtsev
Dmitry Kozlovtsev

🐛
Enoumy
Enoumy

💻
ethamck
ethamck

🎨

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

Commit count: 811

cargo fmt