Skip to content

Latest commit

 

History

History
32 lines (19 loc) · 1.61 KB

README.md

File metadata and controls

32 lines (19 loc) · 1.61 KB
Raw

sweclockersdark-logo

Contributions and Development

If you would like to contribute to this repository, please...

  1. fork Fork the repository then clone it locally.
  2. Make sure you have these installed:
  • node: version 12 or greater

  1. Run npm install to install the necessary node packages.

  2. Make sure your IDE or text editor such as Visual Studio Code / Notepad++ supports reading .editorconfig.

  3. Modify src/sweclockers-dark.styl, it's the file that GitHub Actions uses to generate the final ones.

Live editing methods

This project uses browser-sync to inject the generated .css file into your browser.

Editing using a single script (Recommended)

You can get up and running by simply executing the command npm run local.

This uses gulp to start the browser sync and in the same script also watch and generate changes done to src/sweclockers-dark.styl.

Generate and run server seperately

To generate dist/sweclockers-dark.css file once, run npm run stylus, if you want it to generate the file every time changes occur to src/sweclockers-dark.styl, run npm run stylus-watch.

You can run the browser-sync script with npm run browser-sync and it will inject the dist/sweclockers-dark.css file onto a proxied version of https://www.sweclockers.com/ .