csstyle icon indicating copy to clipboard operation
csstyle copied to clipboard

autodoc

Open joaomilho opened this issue 9 years ago • 5 comments

One cool thing would be to be able to autodoc all components. This doc would show every component and option available along with html samples and the results. Since you already define components with functions it would remove a lot of boilerplate from https://github.com/kneath/kss. WDYT?

joaomilho avatar Nov 01 '14 12:11 joaomilho

Super interesting idea, hadn't thought of that.

geddski avatar Nov 01 '14 18:11 geddski

Think it should integrate with something like kss or generate its own?

geddski avatar Nov 01 '14 19:11 geddski

There is also SassDoc

varemenos avatar Nov 11 '14 09:11 varemenos

Fwiw SassDoc is great for documenting functions and mixins but doesn't support documenting classes or placeholder though.

Undistraction avatar Nov 11 '14 18:11 Undistraction

Fwiw SassDoc is great for documenting functions and mixins but doesn't support documenting classes or placeholder though.

We do support placeholders, for a while now by the way. SassDoc aims at documenting Sass code: variables, placeholders, functions and mixins. Not CSS selectors, as you said.

KittyGiraudel avatar Nov 22 '14 11:11 KittyGiraudel