-
Notifications
You must be signed in to change notification settings - Fork 193
Add dark mode support to documentation website #277
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Add dark mode support to documentation website #277
Conversation
Apache.Shiro.mp4 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds optional dark mode support to the Apache Shiro documentation website and introduces a new troubleshooting FAQ page. The dark mode implementation is lightweight and follows modern web practices with CSS variables, localStorage persistence, and smooth transitions.
Changes:
- Added theme toggle functionality with CSS variables for theming
- Created comprehensive troubleshooting & FAQ documentation page
- Updated navigation menus to include troubleshooting link
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/site/assets/js/theme.js | Implements theme toggle logic with localStorage persistence and icon updates |
| src/site/assets/css/base.css | Defines CSS variables for light/dark themes and comprehensive dark mode overrides for Bootstrap and Asciidoctor components |
| src/site/templates/menu.ftl | Adds theme toggle button to navigation and troubleshooting link to Community dropdown |
| src/site/templates/header.ftl | Loads theme.js early in head to prevent theme flash on page load |
| src/site/content/troubleshooting.adoc | New comprehensive FAQ page covering common Shiro issues with practical solutions |
| src/site/content/support.adoc | Adds link to new troubleshooting page in support resources list |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
Hi, Ganesh! I deployed the staging website here: https://shiro.staged.apache.org
However, in dark mode, much text (announcements / blogs) for example is unreadable. Can you please take a look? |
This PR adds optional dark mode support to the Apache Shiro documentation site.
Changes include:
The implementation is lightweight, does not introduce new dependencies,
and follows existing site structure.
Tested locally using Maven site generation.
Closes #266