Ratatui Book

The ratatui-book is written in mdbook.

The book is built as HTML pages as part of a GitHub Action and is available to view at https://ratatui-org.github.io/ratatui-book/.

Feel free to make contributions if you’d like to improve the documentation.

If you want to set up your local environment, you can run the following:

cargo install mdbook --version 0.4.35
cargo install mdbook-admonish --version 1.13.0
cargo install mdbook-svgbob2 --version 0.3.0
cargo install mdbook-linkcheck --version 0.7.7
cargo install mdbook-mermaid --version 0.12.6
cargo install mdbook-emojicodes --version 0.2.2
cargo install mdbook-catppuccin --version 2.0.1

These plugins allow additional features.

mdbook-admonish

The following raw markdown:

```admonish note
This is a note
```

```admonish tip
This is a tip
```

```admonish warning
This is a warning
```

```admonish info
This is a info
```

will render as the following:

mdbook-mermaid

The following raw markdown:

```mermaid
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;
```

will render as the following:

graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;

mdbook-svgbob2

The following raw markdown:

```svgbob
       .---.
      /-o-/--
   .-/ / /->
  ( *  \/
   '-.  \
      \ /
       '
```

will render as the following:

mdbook-emojicodes

The following raw markdown:

I love cats 🐱 and dogs 🐶, I have two, one's gray, like a raccoon 🦝, and the other
one is black, like the night 🌃.

will render as the following:

I love cats 🐱 and dogs 🐶, I have two, one’s gray, like a raccoon 🦝, and the other one is black, like the night 🌃.