search

segmentio / myth

A CSS preprocessor that acts like a polyfill for future versions of the spec.
4.32k stars 130 forks source link

Documentation Updates #80

Open runeimp opened 10 years ago

runeimp commented 10 years ago

Would love to see the docs updated regarding all the new features. Such as where options are set. It's nice that they're defined but I had to review the source to figure out they are defined via an object passed as the second argument to the constructor. Also to know if there are other hidden gems. :-)

MoOx commented 10 years ago

It seems to be defined at the bottom of the api section https://github.com/segmentio/myth#nodejs But you are right, we should make the options more visible.

runeimp commented 10 years ago

Yes, defined but not demonstrated or noted that they are only usable as keys of an object passed as the 2nd argument to the constructor. And no command line usage for browsers or source options. Though after reviewing the source code I see source is inferred from the output file. ;-)

MoOx commented 10 years ago

@ianstormtaylor What do you think about moving options section after the example & eventually add a toc after the Why section ?

ianstormtaylor commented 10 years ago

TOC sounds good, maybe even right at the top so its easier to find (before the install header)

and sounds good re: options too!

On Sun, Jul 13, 2014 at 10:45 PM, Maxime Thirouin notifications@github.com wrote:

@ianstormtaylor https://github.com/ianstormtaylor What do you think about moving options section after the example & eventually add a toc after the Why section ?

— Reply to this email directly or view it on GitHub https://github.com/segmentio/myth/issues/80#issuecomment-48867217.