This is the documentation project for Ratatui, a Rust library to build rich terminal user interfaces and dashboards. Note that this book is supplementary to the technical documentation, and not a substitute for it. This is more of a guide book to help our users understand how to build a TUI with Ratatui. If you are looking for documentation on specific structs, enums, traits, methods, etc., please visit our technical documentation on docs.rs.
To read the book in your browser, visit this GitHub page.
If you would instead prefer to read this book locally, install Rust and mdBook:
curl https://sh.rustup.rs -sSf | sh
cargo install mdbook
mdbook serve --open(Or use your favorite package manager).
More information on mdBook can be found in the mdBook docs.
The process for writing these docs is just getting started. Feel free to give some suggestions via GitHub Discussions or chat with us on Discord.