Skip to content

Latest commit

 

History

History
 
 

README.md

Generating Contentstack SDK Docs

To generate api reference documentation use the following command under the root directory.

Prerequisite

JSDoc supports Node.js 4.2.0 and later. You can install JSDoc globally or in your project's node_modules folder. To install the latest version on npm globally (may require sudo; learn how to fix this):

npm install -g jsdoc

To install the latest version on npm locally and save it in your package's package.json file:

npm install --save-dev jsdoc

Generate documentation

jsdoc -c path/to/config/file