Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

How should HTML in a description be handled? #16

Open
audionerd opened this Issue Dec 8, 2011 · 1 comment

Comments

Projects
None yet
2 participants

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.

gagarine commented Apr 8, 2014

Look at #37 to include example in CSS

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment