giddy

minor tweaks to GitHub + style your GitHub profiles with CSS visible to others!

this readme is a bit h, lmk how to improve it lol

Installation

to install, you'll need a userscript manager. preferably Tampermonkey, but you may use any managers that implement GM functions

once you've installed and setup your userscript manager, click this link for install prompt

Features

• apply custom css to your profile page where anyone with the script can also see
• additional tweaks & improvements to profile page, with an additional bonus of being able to make simple custom css while worrying less about how it looks

if you want to disable profile CSS, you may do so by checking your manager's menu

Create profile CSS

TODO: improve section

you'll need to create a repo with your GitHub username

in that repo, create a file named giddy.css with your css in it

please do note that Giddy does not have a live CSS editor
instead you'll need to install a userstyle manager to work on your css, before pushing to repo

you may use any userstyle manager, but i'd recommend Stylus

• install Stylus (Chrome)
• install Stylus (Firefox)

also, please check out the profile CSS guidelines

Publish profile CSS

TODO: improve section

after you've pushed css to your repo, you'll need to verify css before it's publically shown to others who have Giddy
to do that, file an issue to let me know

Profile CSS guidelines

here's some rough guidelines when creating your css. it probably has issues but i think i'll work for now

1. have common sense. don't be a dick.
2. do not style or obstruct the header and footer
   
3. do not use external or absolute urls. you can only use relative and data urls
   

   body {
     background-image: url("./earth.png");
     background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADg...");
       /* these are fine */
   
     background-image: url("https://raw.githubusercontent.com/macimas/macimas/master/earth.png");
     background-image: url("/earth.png");
       /* these are not */
   }

4. make sure that text can be clearly read
5. make sure your css works in dark and light mode
6. dont make it too overwhelming/uncomfortable to look at