jsdoc-bem

v0.4.1
Plugin for http://usejsdoc.org/ for documenting bem enteties
jsdoc3 docs bem block element modifier

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.

npm i jsdoc-bem

Metadata

  • MIT
  • Whatever
  • Sergej Tatarincev
  • released 2/20/2018

Downloads