Wondering what’s next for npm?Check out our public roadmap! »

    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.

    Install

    npm i jsdoc-bem

    DownloadsWeekly Downloads

    23

    Version

    0.4.1

    License

    MIT

    Unpacked Size

    56.7 kB

    Total Files

    8

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar