v2.1.0

v2.1.0 (2023-11-11)

Features

• cli: add shell completion (a9a79c6)
• style .warning class (#91) (ff9851d)

Build system & distribution

• cargo: reduce build-time dependencies (8e9ea6e)
• cargo: update/unpin clap and mdbook (b209ae7)
• distribution: remove linux-musl, win-gnu, and win32-msvc (170419d)
• nix: add shell completions (#89) (097a72a)
• nix: drop macOS native dependencies (#88) (547ed85)
• website: use mdbook-admonish v1.13.0 (33eb09c)

New Contributors

• @joshka made their first contribution in #78

Full Changelog: v2.0.1...v2.1.0

v2.0.1

v2.0.1 (2023-10-09)

This release ensures that mdbook v0.4.35 and mdbook-admonish avoid conflicts as a result of the new warning key included within mdbook itself.

Please ensure that you use this release (and future releases) with mdbook-admonish v1.13.0.

Bug Fixes

• admonish: prefix admonish- to class names (#76) (ba711b6) by @CoralPink

Full Changelog: v2.0.0...v2.0.1

v2.0.0

v2.0.0 (2023-10-07)

Important

This release introduces new functionality in the mdbook-catppuccin binary to install new versions of the index.hbs file via the --force flag. Additionally, a version compatibility table has been added to make it easier for users installing and/or upgrading the theme in coordination with mdbook.

If you are updating an existing mdbook to v0.4.35, please upgrade mdbook-catppuccin to v2.0.0 and run mdbook-catppuccin install --force.

⚠ BREAKING CHANGES

• support mdbook version 0.4.35

Features

• cli: add "--force" flag to install command (28f9d0f)
• cli: detect differences in major version (8956c61)
• support mdbook version 0.4.35 (55e8722)

Full Changelog: v1.2.0...v2.0.0

v1.2.0

1.2.0 (2023-10-03)

Important

This release only supports up until mdbook version 0.4.34

Features

• darken struckout text (5388763)
• switch to clap v4 (a1ddb9a)

Bug Fixes

• clap typecasting panic (1193c91)
• colours in diff codeblock (#67) (a3b3f77)

New Contributors

• @CoralPink made their first contribution in #67

Full Changelog: v1.0.0...v1.2.0

v1.0.0

This release introduces highlighting support for the very popular mdbook-admonish plugin. The existing catppuccin.css and catppuccin-highlight.css files have been merged and a new catppuccin-admonish.css file is included by default.

Note

The catppuccin-admonish.css file is NOT required if you are not using the mdbook-admonish plugin. This file can be easily removed by modifying the additional-css key in book.toml.

You can preview what these admonishments look like on our website.

⚠ BREAKING CHANGES

• merge css files and separate admonish

Features

• add mdbook-admonish support (#59) (c8ba6ec)
• style nested blockquote and hr (f78383c)

Code Refactoring

• merge css files and separate admonish (5a160cd)

---

Full Changelog: v0.2.1...v1.0.0

v0.2.1

Fixes

• add cargo feature for crate_version by @sgoudham (dde0c18)
  • This fixes #52
• pin mdbook to 0.4.22 by @nyxkrage (cc92a34)
  • This will prevent issues like #52 from happening again.
• Fix source filter in flake.nix by @VojtechStep in #51

New Contributors

• @VojtechStep made their first contribution in #51

Full Changelog: v0.2.0...v0.2.1

v0.2.0

🛑 This Version Has Been Yanked 🛑

Please use https://github.com/catppuccin/mdBook/releases/tag/v0.2.1 instead.

---

Apologies for leaving this on the back burner for so long!

This release makes the port more maintainable as we are now using catppuccin/highlightjs for the majority of the CSS. There have also been improvements to the CI/CD pipeline to distribute a wider array of binaries.

We now also have an example book deployed at https://mdbook.catppuccin.com for people that are interested in trying out the theme but don't want to download it!

Thanks to anyone who chooses to use this, I really appreciate it <3

Feature

• general:
  • use npm package imports, update highlightjs (f3bcc7e) (#39)
  • dependabot is over party (07a4d8a) (#16)

Bug Fixes

• general:
  • different colours for code blocks and inline code (87a1749)
  • code backgrounds updated to mantle (5feb4df) (#45)
  • update to fixed highlightjs version (98cf81a) (#39)
  • move output from /bin/assets to /src/bin/assets (759ad4f) (#39)

Documentation

• general:

  • add example mdBook (3469e9e) (#45)

• README:

  • standardise with template repository (3844bd1) (#45)

Refactor

• general:
  • links should be blue (6cce7d0) (#45)

New Contributors

• @nullchilly made their first contribution in #16
• @nekowinston made their first contribution in #39

Full Changelog: v0.1.1...v0.2.0

v0.1.1

CHANGELOG

v0.1.1 - 2022-08-27 21:05:04

The default theme Ayu was not included within the given index.hbs, this has now been fixed

Bug Fixes

• general:
  • Add 'ayu' back into index.hbs (45220f0) (#1)

Documentation

• README:
  • Add ayu into diff codeblock example (b68dac3) (#1)
  • Add binaries section (9f7bae8)
  • Update link for index.hbs (200008e)

v0.1.0

🎉 The first-ever release of mdbook-catppuccin 🎉