PhilJ / gulp-kss

Gulp plugin for KSS (Knyle Style Sheets) documentation generation
50 stars 34 forks source link

Is there something specific that needs to go in the markdown document? #8

Open adamjgrant opened 10 years ago

adamjgrant commented 10 years ago

I don't see any documentation from this from kss, kss-node, or gulp-kss.

Currently, I see the styleguide, but my comments don't find my way into it. I assume I need to declare something in my markdown that says "styleguide" and the version so it will trigger the right comments?

willpracht commented 10 years ago

KSS documentation is terrible.

Essentially the styleguide.md is your Overview page. From there you have your stylesheet comments:

// Buttons
//
// A majority of buttons in the site are built from the same base class.
//
// Markup:
// <a href="#" class="button {$modifiers}">Link Button</a>
// <button class="button {$modifiers}">Button Element</button>
// <input type="button" class="button {$modifiers}" value="input[type='button']"/>
//
// .primary             - Indicate that the button is the primary feature of this form.
// .remove              - Indicate that the button will remove a feature, or other negative connotations.
// :hover               - Highlight the button when hovered.
// :disabled            - Make the button change appearance to reflect it being disabled.
// :active              - "Press" the button down when clicked.
//
// Styleguide 1.1
a.button.primary {
  color: blue;
}
a.button.remove {
  color: red;
}
a.button:hover {
  color: gray;
}

Here's some more help: https://stackoverflow.com/questions/10418387/setting-up-knyle-style-sheets-and-or-kss-node/23117663#23117663

adamjgrant commented 10 years ago

Thank you.

Adam Kochanowicz

2014-08-27 11:49 GMT-04:00 Will Pracht notifications@github.com:

KSS documentation is terrible.

Essentially the styleguide.md is your Overview page. From there you have your stylesheet comments:

// Buttons // // A majority of buttons in the site are built from the same base class. // // Markup: // Link Button // // // // .primary - Indicate that the button is the primary feature of this form. // .remove - Indicate that the button will remove a feature, or other negative connotations. // :hover - Highlight the button when hovered. // :disabled - Make the button change appearance to reflect it being disabled. // :active - "Press" the button down when clicked. // // Styleguide 1.1 a.button.primary { color: blue; } a.button.remove { color: red; } a.button:hover { color: gray; }

Here's some more help: https://stackoverflow.com/questions/10418387/setting-up-knyle-style-sheets-and-or-kss-node/23117663#23117663

— Reply to this email directly or view it on GitHub https://github.com/PhilJ/gulp-kss/issues/8#issuecomment-53594628.