Notice: Thanks to everyone who has used, starred, or contributed to this project! Due to a lack of time, I am no longer able to actively develop or provide support for wiki-tui.

If you've alternative projects, write me and I can link to them here in the readme.

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

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

Similar Projects

• hexrcs/wiki-cli
• yashinghcodes/wik

Acknowledgements

• ratatui
• rust
• mkdocs
• mkdocs-material

Contributors ✨

Thanks goes to these wonderful people (emoji key):

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