Skip to content

Commit

Permalink
docs(README): add version compatibility table
Browse files Browse the repository at this point in the history
  • Loading branch information
sgoudham committed Oct 7, 2023
1 parent ac73aa5 commit 1c02253
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@

### Rust (Preferred)

1. Install `mdbook-catppuccin` by running `cargo install mdbook-catppuccin` or download the latest [release](https://github.com/catppuccin/mdBook/releases/latest).
1. Install by running `cargo install mdbook-catppuccin` or download the latest [release](https://github.com/catppuccin/mdBook/releases/latest).

2. Navigate to your mdBook's root directory (same location where the `book.toml`
lives) and run `mdbook-catppuccin install`
Expand Down Expand Up @@ -72,6 +72,21 @@
5. Build your mdBook using `mdbook build` and enjoy your new catppuccin
flavours!

### Version Compatibility

This table shows the compatibility between the mdBook version and the mdbook-catppuccin version.

> [!IMPORTANT]
> Updates to the major version are **BREAKING CHANGES** to the
> `index.hbs` file, which means that you will have to update the file manually
> or use `mdbook-catppuccin install --force` flag to overwrite the `index.hbs`
> upon installation.
| mdbook-catppuccin | mdBook |
| ----------------- | ------ |
| 1.x.x | 0.4.22 → 0.4.34 |
| 2.x.x | 0.4.35 → latest |

### Development

1. Clone the repository and navigate to the repository root.
Expand Down

0 comments on commit 1c02253

Please sign in to comment.