🌻 Latte
🪴 Frappé
🌺 Macchiato
🌿 Mocha
Install mdbook-catppuccin
by running cargo install mdbook-catppuccin
or download the latest release.
Navigate to your mdBook's root directory (same location where the book.toml
lives) and run mdbook-catppuccin install
Build your mdBook using mdbook build
and enjoy your new catppuccin
flavours!
Navigate to src/bin/assets
within this repository
Download all assets: index.hbs
, catppuccin.css
and
catppuccin-highlight.css
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
)
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"]
Build your mdBook using mdbook build
and enjoy your new catppuccin
flavours!
Minimum Rust Version: 1.63.0
shell
git clone https://github.com/catppuccin/mdbook
cd mdbook
cargo build --release
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:
index.hbs (L125 - L133)
and remove the themes that you don't want. Remember to run mdbook build
again!```diff
Inspiration for the install
command came from
mdbook-admonish which is
another great mdBook pre-processor!
Copyright © 2021-present Catppuccin Org