Awesome
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.
<br>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, 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
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):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tbody> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/Builditluc"><img src="https://avatars.githubusercontent.com/u/37375448?v=4?s=100" width="100px;" alt="Builditluc"/><br /><sub><b>Builditluc</b></sub></a><br /><a href="#ideas-Builditluc" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/Builditluc/wiki-tui/commits?author=Builditluc" title="Code">💻</a> <a href="https://github.com/Builditluc/wiki-tui/commits?author=Builditluc" title="Documentation">📖</a> <a href="https://github.com/Builditluc/wiki-tui/issues?q=author%3ABuilditluc" title="Bug reports">🐛</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/0323pin"><img src="https://avatars.githubusercontent.com/u/90570748?v=4?s=100" width="100px;" alt="0323pin"/><br /><sub><b>0323pin</b></sub></a><br /><a href="https://github.com/Builditluc/wiki-tui/issues?q=author%3A0323pin" title="Bug reports">🐛</a> <a href="#platform-0323pin" title="Packaging/porting to new platform">📦</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/legendofmiracles"><img src="https://avatars.githubusercontent.com/u/30902201?v=4?s=100" width="100px;" alt="legendofmiracles"/><br /><sub><b>legendofmiracles</b></sub></a><br /><a href="#platform-legendofmiracles" title="Packaging/porting to new platform">📦</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/ThomasFrans"><img src="https://avatars.githubusercontent.com/u/48214567?v=4?s=100" width="100px;" alt="Thomas"/><br /><sub><b>Thomas</b></sub></a><br /><a href="#platform-ThomasFrans" title="Packaging/porting to new platform">📦</a> <a href="https://github.com/Builditluc/wiki-tui/issues?q=author%3AThomasFrans" title="Bug reports">🐛</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/nunotexbsd"><img src="https://avatars.githubusercontent.com/u/43720668?v=4?s=100" width="100px;" alt="Nuno Teixeira"/><br /><sub><b>Nuno Teixeira</b></sub></a><br /><a href="#platform-nunotexbsd" title="Packaging/porting to new platform">📦</a></td> <td align="center" valign="top" width="14.28%"><a href="http://juans.dev"><img src="https://avatars.githubusercontent.com/u/47149574?v=4?s=100" width="100px;" alt="cshjsc"/><br /><sub><b>cshjsc</b></sub></a><br /><a href="https://github.com/Builditluc/wiki-tui/commits?author=cshjsc" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/non-descriptive"><img src="https://avatars.githubusercontent.com/u/5757533?v=4?s=100" width="100px;" alt="Dmitry Kozlovtsev"/><br /><sub><b>Dmitry Kozlovtsev</b></sub></a><br /><a href="https://github.com/Builditluc/wiki-tui/issues?q=author%3Anon-descriptive" title="Bug reports">🐛</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/Enoumy"><img src="https://avatars.githubusercontent.com/u/45022810?v=4?s=100" width="100px;" alt="Enoumy"/><br /><sub><b>Enoumy</b></sub></a><br /><a href="https://github.com/Builditluc/wiki-tui/commits?author=Enoumy" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/ethamck"><img src="https://avatars.githubusercontent.com/u/111709736?v=4?s=100" width="100px;" alt="ethamck"/><br /><sub><b>ethamck</b></sub></a><br /><a href="#design-ethamck" title="Design">🎨</a> <a href="#platform-ethamck" title="Packaging/porting to new platform">📦</a></td> </tr> </tbody> </table> <!-- markdownlint-restore --> <!-- prettier-ignore-end --> <!-- ALL-CONTRIBUTORS-LIST:END -->This project follows the all-contributors specification. Contributions of any kind welcome!