jsdoc-bem

0.4.1 • Public • Published

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.

Dependencies (0)

    Dev Dependencies (0)

      Package Sidebar

      Install

      npm i jsdoc-bem

      Weekly Downloads

      2

      Version

      0.4.1

      License

      MIT

      Unpacked Size

      56.7 kB

      Total Files

      8

      Last publish

      Collaborators

      • arikon
      • scf
      • sevinf