kss icon indicating copy to clipboard operation
kss copied to clipboard

How should HTML in a description be handled?

Open audionerd opened this issue 13 years ago • 1 comments

According to the spec:

CSS rules that depend on specific HTML structures should describe those structures using <element#id.class:pseudo> notation. For example:

// A feed of activity items. Within each <section.feed>, there should be many
// <article>s which are the  feed items.

But the spec doesn't indicate how those pseudo-HTML blocks should be displayed in the output of a generated styleguide.

I'm assuming they should be output as plain-text, escaped, and not actually inserted as HTML?

Personally, I would actually prefer if there was some way to include raw HTML examples right in the KSS docs. I think keeping the HTML next to the CSS could – in certain cases – be helpful.

audionerd avatar Dec 08 '11 07:12 audionerd

Look at #37 to include example in CSS

gagarine avatar Apr 08 '14 23:04 gagarine