You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@shiro.apache.org by "GaneshPatil7517 (via GitHub)" <gi...@apache.org> on 2026/01/18 16:27:20 UTC

[I] Add dark mode theme support to documentation website [shiro-site]

GaneshPatil7517 opened a new issue, #266:
URL: https://github.com/apache/shiro-site/issues/266

   ## Summary
   Add a dark mode toggle to the Apache Shiro documentation website to improve user experience and accessibility, especially for developers who prefer dark themes.
   
   ## Current State
   The website only supports a light theme. Many modern documentation sites (e.g., MDN, GitHub Docs) offer dark mode options.
   
   ## Proposed Changes
   1. Add CSS variables for theme colors in `src/site/assets/css/base.css`
   2. Create dark mode stylesheet or CSS variables
   3. Add a theme toggle button in the header template (`src/site/templates/header.ftl`)
   4. Use JavaScript to persist user preference in localStorage
   5. Respect system preference via `prefers-color-scheme` media query
   
   ## Acceptance Criteria
   - [ ] Dark mode toggle button visible in site header
   - [ ] Theme persists across page navigation and browser sessions
   - [ ] Respects OS-level dark mode preference as default
   - [ ] Code blocks (Highlight.js) have appropriate dark theme
   - [ ] All text remains readable with sufficient contrast (WCAG AA)
   - [ ] No visual glitches during theme transition
   
   ## Technical Notes
   - Templates are in FreeMarker (`.ftl` files) in `src/site/templates/`
   - CSS files are in `src/site/assets/css/`
   
   **Labels:** `enhancement`, `accessibility`, `css`


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@shiro.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [I] Add dark mode theme support to documentation website [shiro-site]

Posted by "lprimak (via GitHub)" <gi...@apache.org>.
lprimak closed issue #266: Add dark mode theme support to documentation website
URL: https://github.com/apache/shiro-site/issues/266


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@shiro.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [I] Add dark mode theme support to documentation website [shiro-site]

Posted by "GaneshPatil7517 (via GitHub)" <gi...@apache.org>.
GaneshPatil7517 commented on issue #266:
URL: https://github.com/apache/shiro-site/issues/266#issuecomment-3765464745

   hey @lprimak can i work on this...


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@shiro.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [I] Add dark mode theme support to documentation website [shiro-site]

Posted by "GaneshPatil7517 (via GitHub)" <gi...@apache.org>.
GaneshPatil7517 commented on issue #266:
URL: https://github.com/apache/shiro-site/issues/266#issuecomment-3767110597

   hey @lprimak take loo at this when you get time: https://github.com/apache/shiro-site/pull/277


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@shiro.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org