JS Doc Configuration

jsdoc.conf.json

{
  "tags": {
    "allowUnknownTags": true,
    "dictionaries": ["jsdoc", "closure"]
  },
  "source": {
    "include": ["src"],
    "includePattern": ".+\\.js(doc|x)?$",
    "excludePattern": "(^|\\/|\\\\)_"
  },
  "plugins": ["plugins/markdown", "better-docs/component"],
  "templates": {
    "better-docs": {
      "name": "My React components"
    }
  },
  "opts": {
    "destination": "docs",
    "recurse": true,
    "readme": "README.md"
  }
}

JsDocInstructions.txt

To generate HTML from our comments, we need to use jsdoc npm package

We can install it using

$ npm i jsdoc
We'll also need to install better-docs plugin for jsdocs.

$ npm i better-docs
Then we need to create a config file

$ touch jsdoc.conf.json
now add the configuration options in the file

You can create an npm script that can generate the documentation for you

...
"scripts": {
  ...
    "docs": "jsdoc -c jsdoc.conf.json"
  ...
}
...
At last, you can generate the documentation with the following command

npm run docs
Now the documentation can be found in the /docs directory.