NOTE: ALPHA Release This is not fully complete. It's mostly clipped verbatim from a theme I'm working on. It may be useful in its current state, but no promises... yet.

Boilerplate for creating User Styles

Boilerplate for creating user styles for website themes

Table of Contents

Using the Theme
Modifying the Theme
See Also
Gallery

Using the Theme

Install A Browser Plugin

There are a couple of options for installing the theme in your browser.

Stylus is a browser extension for Chrome, Firefox, and Opera that allows you to override the styling of websites, to change their appearance.

• Stylus for Chrome
• Stylus for Firefox
• Stylus for Opera

Tampermonkey is a browser extension for Chrome, Firefox, Edge, Opera, and Safari that allows running scripts to change the behavior of websites and add new functionality.

• Tampermonkey for Chrome
• Tampermonkey for Firefox
• Tampermonkey for Edge
• Tampermonkey for Opera
• Tampermonkey for Safari

Note: Stylish is no longer supported, nor endorsed. What used to be a well known and respected extension was sold and resold and ended up in the hands of an analytics company that captures and transmits your browsing history. Fortunately there are now better options. The Stylish extension and the UserStyles.org website are no longer needed for this theme.

Install the Theme

Once you've installed one of the extensions above, you are ready to install the theme:

• From its home page at OpenUserCSS

Or directly from here:

• For Stylus users:
  

• For Tampermonkey users:
  

Modifying the Theme

Install Build Tools

• git
• Node.js

Clone the Repository

git clone https://github.com/simsrw73/boilerplate-userstyle-theme.git my-theme

Install Build Dependencies

cd my-theme
npm install

Build your Theme

npm run build

Or, to continuously monitor changes and automatically rebuild:

npm run watch

Test your Theme

Load the theme in to your browser with the Stylus extension by either: dragging the file "theme.user.css" to your browser or using the Open Dialog in the browser (Ctrl-o). When Stylus opens the install window, check the options Check for updates and Live reload, and then click the Install style button.

Release your Theme

Build the final relase version of the theme:

npm run release

Import the Theme to the Browser Plugin

Stylus is the best option for development. It has a feature, Live Reload, that detects changes to the file on disk and reloads the changes.

See Installation in Stylus documentation.

Note:* For Chrome, permissions need to be enabled for Live Reload to work. Go to the Extensions page and Click on "Details" for the Stylus extension. Scroll down and enable "Allow access to file URLs"

See Also

Related themes, scripts, extensions.

Find more custom themes at OpenUserCSS.

Gallery