CodeKit2 icon indicating copy to clipboard operation
CodeKit2 copied to clipboard

Feature Request: Code Documenter Add-on

Open KillerDesigner opened this issue 9 years ago • 3 comments

Team i57 (Bryan):

It would be awesome to build AND document code using CodeKit by integrating one of the following (or a custom) CSS / HTML / JS Living Style Guide solutions. The idea is to comment code with markdown, then have it dynamically generate templated HTML documentation (Bootstrap/Foundation), as shown in the examples below.

I believe Kalei (http://kaleistyleguide.com/) may be the best candidate for a fast, easy implementation.

For a reference to the Documentation Builders, and which platforms they operate on, visit The Style Guide Guide at http://vinspee.me/style-guide-guide/.

Solutions

Hologram http://trulia.github.io/hologram-example/index.html Kalei Style Guide http://kaleistyleguide.com/ KSS http://warpspire.com/kss/ Pattern Lab http://patternlab.io/ StyleDocco http://jacobrask.github.io/styledocco/ TopCoat TopDoc http://topcoat.io/posts/generating-css-component-documentation/ Style Guide Generator Roundup http://welchcanavan.com/styleguide-roundup/

Examples

Hologram http://trulia.github.io/hologram-example/base_css.html Kalei Style Guide http://kaleistyleguide.com/ KSS http://warpspire.com/kss/styleguides/ (is seeking guidance on non-Ruby implementation) PatternLab http://demo.patternlab.io/ (seems most agnostic)

KillerDesigner avatar Jan 25 '15 00:01 KillerDesigner

+1

jordanlewin avatar Dec 02 '15 15:12 jordanlewin

I'd be into this.

calvinjuarez avatar Dec 02 '15 19:12 calvinjuarez

+1

dazgreer avatar Feb 16 '16 09:02 dazgreer