Skip to content

Website

ratatui.rs is built with Astro and Starlight.

The source is available from the ratatui-org/website GitHub repository.

To build and run the site locally:

install necessary packages
npm install
run site
npm run dev

Feel free to make contributions and submit a PR if you’d like to improve the documentation.

Some Guidelines

  • Prefer links from the root rather than using multiple levels of parent links. (e.g. /concepts/backends/comparison/ instead of ../../backends/comparison/).
  • Prefer to add the last slash on links

Custom components

LinkBadge

default outline note danger success caution tip