README.md

Gitter Inspired Dark

About

The Gitter Inspired Dark theme is a Gitter instant messaging service dark style, that refines styling throughout all elements and areas.

Sites Covered

Site Name	Partial	Full
Gitter IM		✔️

*️⃣ Full coverage entails styled while using a free open source account, its not bug free, there possible are elements that were likely missed.

Installing

Using a browser extension:

• Stylus - get the addon for Firefox, Chrome and Opera.

Then install this style using:

➡️ userstyles.org
➡️

This is only available using Stylus (see the documentation). 🎉

➡️ Manually into the editor.

Please refer to the installation documentation for more details.

I Found a Bug

At the first instance of finding a bug, have a look if there is already an open issue, if so add the required information as described in the issue template.

If your issue is new, please open an issue and report your problem.

Contributing

At this time any help is appreciated, so if you can help fix a bug or improve the Gitter Inspired Dark theme, just open a pull request to start the ball rolling.

You will need to ideally:

• Fork the project.

• Limit to the K&R (KNF variation style), and 2 SPACE INDENTATION (no tabs, and no less than 2 spaces).

• K&R - KNF Variation Example:

  element[attr='value'] {
  ··property: value;
  }

• Not Allman

  element[property='value']
  {
  ··property: value;
  }

• Strict space between the selector and the {:

  /* good */
  element[attr='value'] { }
  
  /* bad */
  element[attr='value']{ }

• 2 Space indentation

  /* good */
  ··property: value;
  
  /* bad */
  ····property: value;
  ----property: value;
  ·property: value;

*️⃣ Try to wrap lines at around 80 characters.

Development Scripts

• npm run clean: Runs the Perfectionist script, cleans up after it and fixes some CSS via Stylelint.
• npm run eslint: Lint the JavaScript code in the tools directory.
• npm run lint: Run ESlint & Stylelint scripts.
• npm run major: Creates a semantic major release.
• npm run minor: Creates a semantic minor release.
• npm run patch: Creates a semantic patch release.
• npm run perfectionist: Runs Perfectionist only. The CSS is not cleaned/fixed!
• npm run stylelint: Run stylelint on the CSS file.
• npm run lintfix: Run stylelint with --fix on the CSS file.
• npm run test: Same as npm run lint.
• npm run update: Update development dependencies.

Screens

*️⃣ More screenshots available in screens directory for your perusal.