Skip to content

timja/dark-theme-plugin

 
 

Repository files navigation

Dark Theme for Jenkins

Build Status Gitter Changelog Jenkins Plugin Jenkins Plugin Installs

This repository contains a dark theme for Jenkins.

Requires Jenkins >= 2.249.1

Usage

Installing via Jenkins update center

To install this theme search for 'Dark theme' in your Jenkins update center.

Then go to the "Configure System" page, search for 'Built-in Themes' and select 'Dark (Respect OS/Browser system setting)'

or with the configuration-as-code plugin:

unclassified:
  themeManager:
    disableUserThemes: true
    theme: "darkSystem" # use 'dark' for forcing the dark theme regardless of OS settings

Users can configure the theme from their user profile page, see the theme-manager documentation, for more information.

Simple theme plugin

If you can't install this plugin for some reason you can use the Simple Theme Plugin.

See the plugin documentation for theme installation guidelines.

Note: replace 'tag-name' with the latest released version: GitHub release

The CSS URLs are:

https://cdn.jsdelivr.net/gh/jenkinsci/dark-theme@<tag-name>/src/main/resources/io/jenkins/plugins/darktheme/theme.css
https://cdn.jsdelivr.net/gh/jenkinsci/dark-theme@<tag-name>/src/main/resources/io/jenkins/plugins/darktheme/theme-system.css
  • theme.css - forces dark theme for all users
  • theme-system.css - respects users system setting for dark / light mode, in most cases this is the theme you should be using

or with the configuration-as-code plugin:

unclassified:
  simple-theme-plugin:
    elements:
      - cssUrl:
          url: "https://cdn.jsdelivr.net/gh/jenkinsci/dark-theme@<tag-name>/theme-system.css"
          #url: "https://cdn.jsdelivr.net/gh/jenkinsci/dark-theme@<tag-name>/theme.css"

Screenshots

Main screen:

Main screen

Build console:

Build console log

Browser compatibility

The theme should be compatible with all modern browsers.

No version of IE will be supported.

Jenkins compatibility

This project is in active development and needs a recent version of Jenkins, at least v2.240.

We will do our best to not break new versions of the theme against older supported versions of Jenkins.

To be safe you should use our published releases instead of relying on the master branch

References

Contributing

Any contributions to the dark theme and compatibility are welcome! See CONTRIBUTING.md for the contribution guidelines. And thanks to all contributors!

References

About

Jenkins Dark Theme (Incubated project)

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 50.6%
  • CSS 49.4%