Plugin for http://usejsdoc.org/ for documenting bem enteties
JavaScript
Latest commit fccc665 Sep 4, 2015 @SevInf SevInf 0.3.0
Permalink
Failed to load latest commit information.
plugins Add support for the baseBlock property Sep 3, 2015
templates/docjson Add support for the baseBlock property Sep 3, 2015
.gitignore Add .gitignore, license, and package.json Nov 22, 2013
.jshintrc New output format Dec 12, 2013
LICENSE Add .gitignore, license, and package.json Nov 22, 2013
README.md Add output example to readme and template Nov 22, 2013
conf.json.EXAMPLE Document code and add examples Nov 22, 2013
output.EXAMPLE.json
package.json 0.3.0 Sep 4, 2015

README.md

JSDoc plugin for BEM

Plugin for JSDoc3 which extends it for JS code written using BEM methodology.

Usage

Write JSDoc config file with enabled plugin:

{
    ...
    "plugins": [
        "./path/to/jsdoc-bem/plugins/bem"
    ]
    ...
}

Path to plugin should be specified relatively to jsdoc binary directory.

Run using a command:

jsdoc -d console -t ./path/to/jsdoc-bem/templates/docjson -c ./path/to/conf.json <your files/directories>

Docs will be generated in form of structured JSON and will be printed to STDOUT. Example of output can be seen in output.EXAMPLE.json file.