jacobrask/styledocco — Issue #5: Show HTML code in docs, not CSS
Author: necolas
Created: 2012-03-05 21:10:07+00:00
State: open

Rather than showing huge chunks of CSS in the generated docs, you should show the example HTML that is required for the component. This is a standard pattern in almost all toolkit documentation and styleguides that you would manually generate.

A styleguide should be showing other designers / developers the visual outcome and the HTML required to produce it. If you need to know the CSS, you look in the CSS file.

It would also be good to have an option in the CSS comment to decide whether or not to display the example HTML. That way, variants of a component would not end up displaying all the HTML again when you just want to show how a small tweak to a class can make differences.