https://github.com/hitblast/mdbook-brew
A Homebrew-inspired theme for mdBook.
https://github.com/hitblast/mdbook-brew
css mdbook mdbook-theme mdbook-themes rust rust-lang
Last synced: 26 days ago
JSON representation
A Homebrew-inspired theme for mdBook.
- Host: GitHub
- URL: https://github.com/hitblast/mdbook-brew
- Owner: hitblast
- License: mit
- Created: 2025-06-22T16:10:03.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2025-06-22T16:32:46.000Z (12 months ago)
- Last Synced: 2025-06-22T17:30:47.852Z (12 months ago)
- Topics: css, mdbook, mdbook-theme, mdbook-themes, rust, rust-lang
- Language: CSS
- Homepage:
- Size: 1.26 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mdbook-brew
A Homebrew-inspired mdBook theme.
## Overview
mdbook-brew is a theme for the [mdBook](https://rust-lang.github.io/mdBook/) utility. It replicates the cozy, caffeinated-like atmosphere found in [Homebrew's website](https://brew.sh/).
## Requirements
- [mdBook](https://rust-lang.github.io/mdBook/) should be installed, and you're good.
## Installation
1. Create a new mdBook project with the `--theme` flag:
```bash
$ mdbook init --theme
```
2. Navigate to the directory and in the **theme/** folder, delete everything except **index.hbs**.
3. Clone this repository:
```bash
$ git clone https://github.com/hitblast/mdbook-brew.git
```
4. Copy **src/mdbook-brew.css** from the cloned repo and paste it in the **theme/** folder.
5. In your **book.toml** file, add the following line under the `[output.html]` section:
```toml
[output.html]
theme = "mdbook-brew"
additional_css = ["./theme/mdbook-brew.css"]
```
6. Edit the **index.hbs** file and modify the theme navigation menu's contents:
```diff
-
-
-
-
-
+
```
7. Run `mdbook serve` to preview your book locally.
8. Enjoy!
## Screenshots
> [!NOTE]
> The project showcased in the screenshots is [cutler](https://github.com/cutlerCLI/cutler).
## License
This project is licensed under the [MIT](LICENSE) license.