Automatically generate a style guide from your stylesheets.
CoffeeScript JavaScript
Pull request Compare This branch is 2 commits behind praveenvijayan:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
examples
lib
resources
src
test
.gitignore
LICENSE
Makefile
README.md
package.json

README.md

Styledocs

Styledocs is a style document generator. It parse through stylesheet and creates style documents based on the comments provided in it. Its a customized version of jacobrask's styledocco.

Installation

npm install -g styledocs

Usage

styledocs [options] [INPUT]

styledocco -n "My Project" css or styledocco -n "My Project" style.css

Options

  • --name, -n Name of the project (required)
  • --out, -o Output directory (default: "docs")
  • --resources, -s Directory for custom template, CSS and JavaScript. Can be the same as the output directory if you don't want to overwrite your changes. StyleDocco defaults will be used for any required file not found in this directory. (optional)
  • --preprocessor Custom preprocessor command. To disable preprocessing, use none. (optional) (ex: --preprocessor "scss --load-path=deps/")
  • --include Prepend specified CSS file to the documentation stylesheet. (optional) (ex: --include mysite.css)

    Example

/*#breadcrumb

HomeEmail
*/ .breadcrumb{} .breadcrumb a{} .breadcrumb a:hover{} .breadcrumb span{}