Catppuccin for mdBook

Previews

🌻 Latte

🪴 Frappé

🌺 Macchiato

🌿 Mocha

Installation

Rust (Preferred)

1. Install mdbook-catppuccin by running cargo install mdbook-catppuccin or download the latest release.

2. Navigate to your mdBook's root directory (same location where the book.toml lives) and run mdbook-catppuccin install

3. Build your mdBook using mdbook build and enjoy your new catppuccin flavours!

Manual

1. Navigate to src/bin/assets within this repository

2. Download all assets: index.hbs, catppuccin.css and catppuccin-highlight.css

3. Transfer downloaded assets to your mdBook theme directory (the default directory would be theme/ from the mdBook root if not already specified within the book.toml)

4. Update additional-css key within the book.toml as shown below

   diff [output.html] -additional-css = [] +additional-css = ["./theme/catppuccin.css", "./theme/catppuccin-highlight.css"]

5. Build your mdBook using mdbook build and enjoy your new catppuccin flavours!

Building Locally

Minimum Rust Version: 1.63.0

shell git clone https://github.com/catppuccin/mdbook cd mdbook cargo build --release

🙋 FAQ

• Q: "What's the point of the mdbook-catppuccin binary?"\ A: Arguably, it's better to transfer over the files manually to avoid installing another tool. However, the assets will NOT be managed for you. It is also worth mentioning that the binary will be able to detect differences in versions of assets.

• Q: "How can I remove the default themes?"\ A:

  • Navigate to index.hbs (L125 - L133) and remove the themes that you don't want. Remember to run mdbook build again!
  • E.g. To remove all default themes:

  ```diff

  • {{ theme_option "Light" }}
  • {{ theme_option "Rust" }}
  • {{ theme_option "Coal" }}
  • {{ theme_option "Navy" }}
  • {{ theme_option "Ayu" }}
  • {{ theme_option "Latte" }}
  • {{ theme_option "Frappé" }}
  • {{ theme_option "Macchiato" }}
  • {{ theme_option "Mocha" }}
  ```

Acknowledgement

Inspiration for the install command came from mdbook-admonish which is another great mdBook pre-processor!

💝 Thanks to

• Hamothy
• winston

Copyright © 2021-present Catppuccin Org