Skip to content

Latest commit

 

History

History
60 lines (37 loc) · 1017 Bytes

README.md

File metadata and controls

60 lines (37 loc) · 1017 Bytes
Raw

Docky

Auto-Generate JavaScript documenation.

CLI Usage

Install docky globally:

npm install -g docky

Run docky on a single file or entire folder:

docky src/components/**/*.js

Options

  Usage: docky <files> [options]

  Options:

    -h, --help               output usage information
    -v, --version            output the version number
    -w, --watch              run on file change

Contributing

Docky uses Pug (formally known as Jade) and SASS for template generation. The files can be found under the template directory.

There is a components directory which contains some example React components for testing. You can run docky over the local folder by running:

npm run docs

or

./bin/docky.js components/**/*.js

To compile the sass, run:

npm run sass

Alternatively, you can add a :watch flag to auto-generate on change:

npm run sass:watch