๐ Soothing pastel theme for mdBook
Install the binary using one of the methods below.
Installation Method | Instructions |
---|---|
Rust | cargo install mdbook-catppuccin |
Homebrew | brew install catppuccin/tap/mdbook-catppuccin |
Nix | nix profile install github:catppuccin/mdbook |
GitHub | Download the latest release |
Manual | See below |
Navigate to your mdBook's root directory (same location where the
book.toml lives) and run mdbook-catppuccin install
Build 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-admonish.css
[!NOTE] The catppuccin-admonish.css file is NOT required if you are not using the mdbook-admonish plugin.
Transfer downloaded assets to your mdBook's theme directory (the default
directory is ./theme
beside book.toml
)
Update additional-css
key within the book.toml
as shown below
[output.html]
-additional-css = []
+additional-css = ["./theme/catppuccin.css", "./theme/catppuccin-admonish.css"]
Build using mdbook build
and enjoy your new catppuccin flavours!
This table shows the compatibility between the mdBook version and the mdbook-catppuccin version.
[!IMPORTANT]
Updates to the major version may contain BREAKING CHANGES to theindex.hbs
file, which means that you will have to update the file manually or usemdbook-catppuccin install --force
flag to overwrite theindex.hbs
upon installation.
mdbook-catppuccin | mdBook |
---|---|
1.x.x | 0.4.22 โ 0.4.34 |
2.x.x | 0.4.35 โ latest |
Clone the repository and navigate to the repository root.
git clone https://github.com/catppuccin/mdbook
cd mdbook
Run the following command to generate the CSS files that will be packaged by the rust binary:
cd palette
npm install
npm run build
Build the rust binary using the following command:
Note that the Minimum Rust Version is 1.63.0
cargo build --release
Test the binary by installing the new assets on the example
directory:
cd example
../target/release/mdbook-catppuccin install
mdbook serve
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: "What's the catppuccin-admonish.css
file?"
A: It is a CSS file that is used to style the admonishments that are generated
by mdbook-admonish.
You can remove this file if you are not using this plugin.
E.g.
[output.html]
- additional-css = ["./theme/catppuccin.css", "./theme/catppuccin-admonish.css"]
+ additional-css = ["./theme/catppuccin.css"]
Q: "How can I remove the default themes?"
A: Navigate to index.hbs (L154 - L162)
and remove the themes that you don't want. Remember to run mdbook build
again!
E.g. To remove all default themes:
- <li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
- <li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
- <li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
- <li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
- <li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
+ <li role="none"><button role="menuitem" class="theme" id="latte">Latte</button></li>
+ <li role="none"><button role="menuitem" class="theme" id="frappe">Frappรฉ</button></li>
+ <li role="none"><button role="menuitem" class="theme" id="macchiato">Macchiato</button></li>
+ <li role="none"><button role="menuitem" class="theme" id="mocha">Mocha</button></li>
Additionally, you can use default-theme and preferred-dark-theme keys for setting default light/dark mode themes.
E.g. To set the default theme to latte
and default dark mode to mocha
:
[output.html]
+ default-theme = "latte"
+ preferred-dark-theme = "mocha"
Inspiration for the install
command came from
mdbook-admonish which is
another great mdBook pre-processor!
ย
Copyright ยฉ 2021-present Catppuccin Org