35
35
<img src =" assets/mocha.webp " />
36
36
</details >
37
37
38
- ## Installation
38
+ ## Usage
39
39
40
- ### Rust (Preferred)
40
+ 1 . Install the binary using one of the methods below.
41
41
42
- 1 . Install by running ` cargo install mdbook-catppuccin ` or download the latest [ release] ( https://github.com/catppuccin/mdBook/releases/latest ) .
42
+ | Installation Method | Instructions |
43
+ | ------ | ------- |
44
+ | ** Rust** | ` cargo install mdbook-catppuccin ` |
45
+ | ** Homebrew** | ` brew install catppuccin/tap/mdbook-catppuccin ` |
46
+ | ** Nix** | ` nix run github:catppuccin/mdbook -- install ` |
47
+ | ** GitHub** | Download the [ latest release] ( https://github.com/catppuccin/mdBook/releases/latest ) |
48
+ | ** Manual** | [ See below] ( #manual-installation ) |
43
49
44
- 2 . Navigate to your mdBook's root directory (same location where the ` book.toml `
45
- lives) and run ` mdbook-catppuccin install `
50
+ 2 . Navigate to your mdBook's root directory (same location where the
51
+ ** book.toml ** lives) and run ` mdbook-catppuccin install `
46
52
47
- 3 . Build your mdBook using ` mdbook build ` and enjoy your new catppuccin
48
- flavours!
53
+ 3 . Build using ` mdbook build ` and enjoy your new catppuccin flavours!
49
54
50
- ### Manual
55
+ ### Manual Installation
51
56
52
- 1 . Navigate to ` src/bin/assets ` within this repository
57
+ 1 . Navigate to [ src/bin/assets] ( ./src/bin/assets ) within this repository
53
58
54
- 2 . Download all assets: ` index.hbs ` , ` catppuccin.css ` and
55
- ` catppuccin-admonish.css `
59
+ 2 . Download all assets: [ index.hbs] ( ./src/bin/assets/index.hbs ) ,
60
+ [ catppuccin.css ] ( ./src/bin/assets/catppuccin.css ) and [ catppuccin -admonish.css] ( ./src/bin/assets/catppuccin-admonish.css )
56
61
57
62
> [ !NOTE]
58
- > The ` catppuccin-admonish.css ` file is ** NOT ** required if you are not using
59
- > the [ mdbook-admonish] ( https://github.com/tommilligan/mdbook-admonish ) plugin.
63
+ > The [ catppuccin-admonish.css] ( ./src/bin/assets/catppuccin-admonish.css )
64
+ > file is ** NOT ** required if you are not using the [ mdbook-admonish] ( https://github.com/tommilligan/mdbook-admonish ) plugin.
60
65
61
66
3 . Transfer downloaded assets to your mdBook's theme directory (the default
62
67
directory is ` ./theme ` beside ` book.toml ` )
69
74
+additional-css = ["./theme/catppuccin.css", "./theme/catppuccin-admonish.css"]
70
75
```
71
76
72
- 5 . Build your mdBook using ` mdbook build ` and enjoy your new catppuccin
73
- flavours!
77
+ 5 . Build using ` mdbook build ` and enjoy your new catppuccin flavours!
74
78
75
79
### Version Compatibility
76
80
@@ -87,7 +91,7 @@ This table shows the compatibility between the mdBook version and the mdbook-cat
87
91
| 1.x.x | 0.4.22 → 0.4.34 |
88
92
| 2.x.x | 0.4.35 → latest |
89
93
90
- ### Development
94
+ ## Development
91
95
92
96
1 . Clone the repository and navigate to the repository root.
93
97
0 commit comments