https://github.com/Builditluc/wiki-tui

A simple and easy to use Wikipedia Text User Interface
https://github.com/Builditluc/wiki-tui

cursive rust tui wikipedia wikipedia-api wikipedia-tui

Last synced: 13 days ago
JSON representation

A simple and easy to use Wikipedia Text User Interface

• Host: GitHub
• URL: https://github.com/Builditluc/wiki-tui
• Owner: Builditluc
• License: mit
• Created: 2021-01-19T10:22:19.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2025-03-05T19:24:15.000Z (about 1 month ago)
• Last Synced: 2025-03-28T01:40:24.608Z (18 days ago)
• Topics: cursive, rust, tui, wikipedia, wikipedia-api, wikipedia-tui
• Language: Rust
• Homepage: https://wiki-tui.net/
• Size: 31.1 MB
• Stars: 478
• Watchers: 11
• Forks: 16
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• stars - Builditluc/wiki-tui - A simple and easy to use Wikipedia Text User Interface (Rust)

README

        
[![Contributors](https://img.shields.io/github/all-contributors/builditluc/wiki-tui/main?color=orange&label=Contributors&style=for-the-badge)](#contributors-)

[![Stargazers](https://img.shields.io/github/stars/Builditluc/wiki-tui.svg?style=for-the-badge)](https://github.com/Builditluc/wiki-tui/stargazers)

[![Issues](https://img.shields.io/github/issues/Builditluc/wiki-tui.svg?style=for-the-badge)](https://github.com/Builditluc/wiki-tui/issues)

[![MIT license](https://img.shields.io/github/license/Builditluc/wiki-tui?style=for-the-badge)](https://github.com/Builditluc/wiki-tui/blob/stable/LICENSE.txt)

[![Continuous Integration](https://img.shields.io/github/actions/workflow/status/builditluc/wiki-tui/ci.yml?label=Continuous%20Integration&style=for-the-badge)](https://github.com/Builditluc/wiki-tui/actions/workflows/ci.yml)

[![Continuous Deployment](https://img.shields.io/github/actions/workflow/status/builditluc/wiki-tui/cd.yml?label=Continuous%20Deployment&style=for-the-badge)](https://github.com/Builditluc/wiki-tui/actions/workflows/cd.yml)






  

    

  

  
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, [wiki-tui.net](https://wiki-tui.net/latest)

# 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](https://raw.githubusercontent.com/Builditluc/wiki-tui/main/docs/docs/assets/images/preview-3.png)](docs/docs/assets/images/preview-3.png)

## Similar Projects

* [hexrcs/wiki-cli](https://github.com/hexrcs/wiki-cli)

* [yashinghcodes/wik](https://github.com/yashsinghcodes/wik)

## Acknowledgements

* [ratatui](https://ratatui.rs/)

* [rust](https://www.rust-lang.org/)

* [mkdocs](https://www.mkdocs.org/)

* [mkdocs-material](https://github.com/squidfunk/mkdocs-material)

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    

      
Builditluc
🤔 💻 📖 🐛

      
0323pin
🐛 📦

      
legendofmiracles
📦

      
Thomas
📦 🐛

      
Nuno Teixeira
📦

      
cshjsc
💻

      
Dmitry Kozlovtsev
🐛

    

    

      
Enoumy
💻

      
ethamck
🎨 📦

      
lstuma
🐛

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!