Skip to content

Commit 70f65d3

Browse files
committed
add JSDOC_PATH docs to readme
1 parent b181032 commit 70f65d3

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,13 @@ import jsdoc from 'jsdoc-api'
9999
await jsdoc.render({ files: ['index.js', 'lib/something.js'], destination: 'jsdoc-output' })
100100
```
101101

102+
If you need to use a specific `jsdoc` version or fork, specify its path via `JSDOC_PATH` and jsdoc-api will use it instead of the default.
103+
104+
```sh
105+
$ export JSDOC_PATH=./node_modules/.bin/jsdoc # An alternative jsdoc version you installed
106+
$ node my-jsdoc-api-script.js # Run your jsdoc-api app as usual
107+
```
108+
102109
See the [API documentation](https://github.com/jsdoc2md/jsdoc-api/blob/master/docs/api.md) for further details. See the [example folder](https://github.com/jsdoc2md/jsdoc-api/tree/master/example) for code examples.
103110

104111
* * *

0 commit comments

Comments
 (0)