StyleGuide tools friendly

[pascalduez]

trafficstars

From Twitter

if this somehow worked in conjunction with KSS ( for style guide creation ) it would’ve epic

Might be interesting to run some quick tests on whether it's possible to run both tools alongside, and if there's areas we could intervene to ease this workflow. Provided this does not implies huge changes nor changes to our comments system.

A compatible theme ? KSSmySass ?

[KittyGiraudel]

KSSmySass

Just for the name, I'd want to see that.

[di5abled]

KSSmySass would be awesome xD

I currently run both tools alongside with SassDoc and kss-node via grunt. No Problems so far.

Don't know what exactly do you want to achieve but I also had some thougths about combining this in any way but had no really good idea now. Don't like the idea switching between two different types of documentation style in my scss files.

[pascalduez]

Hey @di5abled, do you hove something on Github to look at ? Also that means having two different documentations generated.

[di5abled]

Hy, nope sorry, there's nothing online right now. But it's really simple, one sass folder where both tools start to parse the files. And I use the following documentation styles, this way no conflicts are happening. And yes this ends up in 2 documentations with different styles...

KSS

/*
title

description
*/

SassDoc

/**
 * description
 *
 * @group Test
 */

[varemenos]

Is there space in SassDoc to possibly integrate a styleguide feature? Wouldn't it be better than trying to support other projects?

[eikeco]

+1 for this. I would love to see it in Sassdocs

[colorful-tones]

+1000 to styleguide in SassDoc.

[xDae]

+1

[vidhill]

With very little work, (and without touching the source),
I was able to get SassDoc to output css class definitions. I know it isn't part of the intended use but it works, I think for a styleguide that would be very sass dependant SassDoc could be a killer tool for styleguides

(+1)

[KittyGiraudel]

Care to share what you did? :)

[pascalduez]

Note: there haven't been an official communication about it yet, but as of [email protected] it's possible to annotate CSS selectors. Though the default theme still and will not process them.

[vidhill]

@HugoGiraudel I might just have stumbled upon that feature added 'as of [email protected]'

I will post a gist later when I get home.

[vidhill]

Here is a gist with what I did to output a css class body, This was a quick and dirty approach, just to see if I could get it to work,

https://gist.github.com/vidhill/c1a062d3f26c8e762419

I know I could also have added a conditional statement to the markdown template also, If there isn't enough detail in the gist let me know..

-SassDoc v2.1.20

[vidhill]

@pascalduez Has anything developed on this side since I last passed by? With regards to annotating CSS selectors

[pascalduez]

@vidhill Nothing new. As said above since [email protected] it's possible to annotate CSS selectors which wasn't enabled before. So you basically have the door open to implement nifty things, but hat means buidlding your own theme, as sassdoc-theme-default will remain focused on Sass libraries, APIS, etc. not styleguides.

[vidhill]

Thanks, Is there any tips for how to properly make use of the feature, As in my Gist above I think I found a way to get the info but what I did feels a bit hacky

[chasemccoy]

@vidhill How did you get it to output the CSS code? I saw your Gist but not sure how to get it to work. You also mentioned putting a conditional in the Markdown template, can you explain that?

[chasemccoy]

Actually scratch that, I was able to figure out how to output the CSS code by editing the Markdown template. Not sure how to output the description comments for CSS though, @vidhill can you clarify this a bit?

[vidhill]

Sorry, I haven't looked at this in a long while, I'll try to re-familiarise myself because it's been so long.

I won't be free to look at it until during the weekend at least..

[vidhill]

I believe this is one of the features of https://github.com/oddbird/sassdoc-theme-herman but I haven't got to try that out yet

[chasemccoy]

@vidhill I didn't see an example of it in the Herman theme. Take your time, I'm not in a rush. Like I said, I got my theme to output the CSS code, I was just curious if there was a way to output the description as well.

[mirisuzanne]

Herman isn't well documented yet, but we do have the basics of css-documentation in there. Feel free to dig around.

[stacyk]

Herman is well documented now :) Give it a try if anyone in this thread is interested: http://oddbird.net/herman/docs/index.html