universal.css icon indicating copy to clipboard operation
universal.css copied to clipboard

Full documentation ?

Open LoicGoyet opened this issue 8 years ago • 5 comments

Can we have a full documentation with all the utility classes ? Please it will save me so many time to not look into your sources.

LoicGoyet avatar May 21 '16 16:05 LoicGoyet

You don't need documentation. Take any CSS rule you want to apply, replace : by -, and dots by -dot-, and you get the name of the corresponding universal css classname. See our FAQ for more details 😉.

RobinBressan avatar May 21 '16 16:05 RobinBressan

(for the record I just wanted to be a part of the troll)

LoicGoyet avatar May 21 '16 17:05 LoicGoyet

Why not write a bash script to generate the documentation from the compiled file :

$ cp universal.css DOCUMENTATION.md

It might need some awk and stuff, though.

I’ll be willing to work on a pull request if it gets enough support.

gabssnake avatar May 22 '16 14:05 gabssnake

@RobinBressan that unfortunately falls foul of the rule that good documentation should explain the why not the what. padding-5px might translate to padding: 5px but that doesn't help tell me what padding is. a comment like //use when you want 5px of padding would be a lot more helpful.

chaoaretasty avatar May 23 '16 15:05 chaoaretasty

@chaoaretasty Let’s include that in the script too!

gabssnake avatar May 23 '16 15:05 gabssnake