Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

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: 8 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 (over 3 years ago)
Default Branch: main
Last Pushed: 2024-03-21T17:07:52.000Z (3 months ago)
Last Synced: 2024-05-22T11:06:10.863Z (25 days ago)
Topics: cursive, rust, tui, wikipedia, wikipedia-api, wikipedia-tui
Language: Rust
Homepage: https://builditluc.github.io/wiki-tui/
Size: 28.5 MB
Stars: 364
Watchers: 9
Forks: 14
Open Issues: 10
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Lists

awesome-stars - Builditluc/wiki-tui - A simple and easy to use Wikipedia Text User Interface (Rust)
awesome-stars - Builditluc/wiki-tui - A simple and easy to use Wikipedia Text User Interface (Rust)
cli-apps - wiki-tui - A simple and easy to use Wikipedia Text User Interface. (<a name="online"></a>Online search and resources)
awesome-cli-apps - wiki-tui - A simple and easy to use Wikipedia Text User Interface. (<a name="online"></a>Online search and resources)

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

# Rewrite and the main branch

wiki-tui is currently going through a complete rewrite (we're switching from cursive to ratatui).

That means that the main branch is going to have an in-development and unfinished version of

wiki-tui for the duration of the rewrite. Please keep that in mind when compiling from source.

Since this is a fairly large change, there won't be new versions released until the rewrite is

complete.

> Feel free to try the development version out!




You can find the **installation instructions**, **configuration options**, **more preview images**, **a feature overview** and more on our website, [builditluc.github.io/wiki-tui](https://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](https://raw.githubusercontent.com/Builditluc/wiki-tui/main/docs/assets/images/preview-3.png)](docs/assets/images/preview-3.png)

> Note: This screenshot was taken on [iTerm2](https://iterm2.com) (MacOS) with the [Fira Code](https://github.com/tonsky/FiraCode) font

## Similar Projects

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

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

## Acknowledgements

* [cursive](https://github.com/gyscos/cursive)

* [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
🎨 📦

    

  

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