https://github.com/cptpiepmatz/mdbook-auto-theme

🎨 A browser extension for automatically applying themes on websites generated by mdBook.
https://github.com/cptpiepmatz/mdbook-auto-theme

auto-dark-mode browser-extension mdbook theme theme-switcher

Last synced: 7 months ago
JSON representation

🎨 A browser extension for automatically applying themes on websites generated by mdBook.

• Host: GitHub
• URL: https://github.com/cptpiepmatz/mdbook-auto-theme
• Owner: cptpiepmatz
• License: mit
• Created: 2023-01-28T09:01:25.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-08T18:14:09.000Z (11 months ago)
• Last Synced: 2025-03-08T20:57:03.049Z (8 months ago)
• Topics: auto-dark-mode, browser-extension, mdbook, theme, theme-switcher
• Language: HTML
• Homepage:
• Size: 83 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          


  

    

  



mdBook Auto Theme



  🎨 A browser extension for automatically applying themes on websites generated by mdBook.








  [![Chrome Web Store Version](https://img.shields.io/chrome-web-store/v/lkdbgbnmahmockjjcjokmnjeeddaoeib?logo=google-chrome&style=for-the-badge)](https://chrome.google.com/webstore/detail/mdbook-auto-theme/lkdbgbnmahmockjjcjokmnjeeddaoeib)

  [![Mozilla Add-On Version](https://img.shields.io/amo/v/mdbook-auto-theme?color=orange&logo=firefox&style=for-the-badge)](https://addons.mozilla.org/firefox/addon/mdbook-auto-theme/)



## Features

- Automatically switches between light and dark mode based on system preferences.

- Select from multiple available themes for light and dark mode: "Light", "Rust", "Coal", "Navy", "Ayu".

- Automatically applies the selected themes on any website generated with mdBook.

- Themes are remembered across all sites.

## Usage

1. Go to a website generated by mdBook, for example the official mdBook documentation website at https://rust-lang.github.io/mdBook/.

2. Click on the extension icon (in the top right corner of your browser, you may need to open some extension menu) to open the settings page.

3. Select the desired theme for light and dark mode from the following options: "Light", "Rust", "Coal", "Navy", "Ayu".

4. Enjoy the new theme on every new page you load.

## Contributing

Please feel free to fork the repository, make changes and submit a pull request. Issues are also welcomed.

## License

This project is licensed under the [MIT License](https://github.com/cptpiepmatz/mdbook-auto-theme/blob/main/LICENSE).

## Acknowledgements

- [mdBook](https://github.com/rust-lang/mdBook)

- [Bulma](https://bulma.io/) (for settings design)

- [bulma-prefers-dark](https://github.com/jloh/bulma-prefers-dark)

- [bulma-checkradio](https://github.com/Wikiki/bulma-checkradio)