• Stars
    star
    410
  • Rank 105,468 (Top 3 %)
  • Language
    Rust
  • License
    MIT License
  • Created almost 4 years ago
  • Updated 4 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A simple and easy to use Wikipedia Text User Interface

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!