Syntax

[jacobrask]

Hi!

I'm working on StyleDocco, a tool that's similar to Kalei, but runs on Node.js. I really like your approach of running in the browser!

There are some other CSS documentation tools out there, and I think it would be very cool if we could work toward making our syntaxes somewhat compatible with each other, to let users easily try out the different tools without doing too many changes to their existing CSS documentation.

Here is a comparison between different syntaxes:

Kalei

/*
Name: Default button
Description: A simple example showing a default button
Markup: <button class="default">Simple button</button>
*/

StyleDocco

/*
Default button
--------------
A simple example showing a default button

    <button class="default">Simple button</button>
*/

Knyle Style Sheets

/*
A simple example showing a default button

.default          - Default styles

Styleguide 2.1.3.
*/
button.default { }

I think headings are added in Ruby in KSS, and that the markup is assumed from the CSS, but I'm not sure.

Do you know of any other documentation tools?

I am obviously biased toward the syntax I'm using in StyleDocco, but I'm willing to compromise if you find the idea interesting.

[thomasdavis]

Hey Jacob, found it pretty funny you posted here. I was just about to implement your concept of Markdown syntax with support for Textile to. Will be doing it right now, yours is far superior. I thought of using Markdown at first but thought it might not work well but StyleDocco does it beautifully.

So I'd love to settle on Markdown as the content type.

I was going to spice Kalei up this weekend and add all the features that StyleDocco has and also adding in;

• Automatic CSS validation with warnings
• Disqus per style sheet
• fixie.js

I was going to turn styles.css into the index page which is also a contents page. and auto generating a quick jump left hand menu generated from markdown headings.

Trying to think about other things we can collaborate on also

[thomasdavis]

@jacobrask Ended up implementing StyleDoccos approach for the css and UI for now. Will update the index page to include credit for inspiration tonight.

[jacobrask]

Cool! Looking forward to try it out