search

kneath / kss

A methodology for documenting CSS and generating styleguides.
warpspire.com/kss
MIT License
4.04k stars 275 forks source link

Support example html in comments and add API to access to Section #77

Closed briansloane closed 11 years ago

briansloane commented 11 years ago

I forked kss from @mkdynamic and merged with the latest master from the https://github.com/kneath/kss repo. This PR contains the updates that there were part of https://github.com/kneath/kss/pull/56 that allowed for putting example html in the comments as follows:

// A basic button.
//
// :hover    - The hover state
// :active   - The pressed state
// :disabled - The disabled state
//
// <button class="m-btn $modifier-class">Button</button>
//
// Styleguide 1.1
benschwarz commented 11 years ago

@briansloane Do you think you'd be able to update the readme and spec pages accordingly? Eg: Example markup can only be one line. Etc

briansloane commented 11 years ago

@benschwarz Sure. I'll get those updated and add to the PR.

briansloane commented 11 years ago

@benschwarz I've updated the readme and spec accordingly. Let me know if you have any other questions.

benschwarz commented 11 years ago

Ok, I think you've won me over too.

Single line HTML would work (but who ever does anything with a single element?) — so it feels like a feature that would leave you wanting more (multi-line HTML, which would be weird).

Thanks for your efforts on this @briansloane, sorry we won't be accepting it.