styledocco

 _______ __         __        _____
|     __|  |_.--.--|  |-----.|     \-----.----.----.-----.
|__     |   _|  |  |  |  -__||  --  | _  |  __|  __|  _  |
|_______|____|___  |__|_____||_____/_____|____|____|_____|
             |_____|

StyleDocco generates documentation and style guide documents from your stylesheets.

Stylesheet comments will be parsed through Markdown and displayed in a generated HTML document. You can write code examples inside GitHub Markdown code fences (```) or prefixed with 4 spacesin your comments, and StyleDocco both renders the HTML and shows the code example.

The document automatically starts a new section when it encounters a level 1 or 2 heading. Read more about the syntax in the Markdown guide. Only comments at the beginning of new lines are included, so to exclude something from the style guide, put some whitespace before the comment.

If your project includes a README file, it will be used as the base for an index.html. StyleDocco will also add some default styles to your documentation, but they are easy to modify to make it fit with your project.

StyleDocco will automatically compile any SASS, SCSS, Less or Stylus code before it is applied to the page.

Installation

StyleDocco requires Node.js.

npm install -g styledocco

or clone the GitHub repository.

StyleDocco is free software, released under the MIT license.

Usage

styledocco [options] [INPUT]

Options

• --name, -n Name of the project (required)
• --out, -o Output directory (default: "docs")
• --tmpl Directory for custom index.jade and docs.jade templates (optional)
• --overwrite Overwrite existing files (docs.css) in target directory.

Examples

<button class="btn primary">Primary</button>  

This page is an example itself, as it was generated from the StyleDocco readme file. The docs file is the documentation of the default StyleDocco CSS file.

An additional example was generated from a modified file of the Twitter Bootstrap project.

Acknowledgements

A lot of the heavy lifting in StyleDocco is done by the excellent Marked module by Christopher Jeffrey. The original Docco by Jeremy Ashkenas and Docco Husky by Mike Brevoort were also of great help to this project.