https://github.com/bem/bem-jsdoc3-plugin
Plugin for http://usejsdoc.org/ for documenting bem enteties
https://github.com/bem/bem-jsdoc3-plugin
Last synced: about 1 year ago
JSON representation
Plugin for http://usejsdoc.org/ for documenting bem enteties
- Host: GitHub
- URL: https://github.com/bem/bem-jsdoc3-plugin
- Owner: bem
- License: mit
- Created: 2013-11-22T10:35:04.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2018-02-20T09:53:03.000Z (over 8 years ago)
- Last Synced: 2025-03-20T19:17:38.343Z (over 1 year ago)
- Language: JavaScript
- Size: 29.3 KB
- Stars: 3
- Watchers: 17
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JSDoc plugin for BEM
Plugin for [JSDoc3](http://usejsdoc.org/) which extends it for JS code
written using [BEM](http://bem.info/) methodology.
## Usage
Write [JSDoc config file](http://usejsdoc.org/about-configuring-jsdoc.html) with
enabled plugin:
```javascript
{
...
"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
```
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](/output.EXAMPLE.json) file.