Full API documentation

[akrueger]

Hi, thanks for Jeet.

Is there a document that lists the full API. I really like the quick cheatsheet overview on the main website, but I am trying to explore all of the options for certain parameters, e.g.

ALIGN (direction = both)

I tried horizontal and vertical and both worked which was great, but these were just guesses and I am not sure if there are other options. The same question for all of the API keeps coming up for me.

I have gleaned a good bit from looking through the source code, but figured I'd ask.

*Also, not sure if there is a difference between SCSS and Stylus for the syntax of the max width argument to center(), but I was only able to get it to work with max-width in Stylus.

CENTER (max_width = 1410px, pad = 0)

[pixeldesu]

@akrueger Since I just released a new version that opens the path for better updates, I'll also prepare a seperate page for the documentation instead of a sidebar you need to toggle!

[damienmcd]

One thing I found slightly confusing when I began using Jeet was the use of parameters to functions requiring the $ in SCSS.

For example: @include col(1/2, $gutter: 5, $uncycle: 3, $cycle: 2);

Would be very convenient to have a note in the documentation to highlight that the $ is required. Once you know it's required, you'll never forget it. It might help people starting out with Jeet.

[corysimmons]

@akrueger This is part of the 7.0.0 PR. It only displays the Sass version of the arguments, but the params are the same so it shouldn't be too hard to figure out the Stylus alternative by browsing _grid.styl for a sec.

@damienmcd np, this is actually supposedly a convention in Stylus, but Stylus' docs/community is all over the place with conventions (a bad thing).

If I get time I'll update the Stylus site to reflect these conventions.