Home

readme title

This content diplayed in home page of the documentation generated is from readme.md

Tutorial pages

Tutorial pages are created from the folder set in jsdoc config file jsdoc config file could be passed to jsdoc in two ways

  1. directly as argument , eg: jsdoc -c jsdoc.json
  2. or set in package.json and using node js. eg: npm run doc

pacakge.json

see scripts>>doc in pacakge.json

{
  "name": "tut2",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "doc": "jsdoc -c jsdoc.json"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "jsdoc":"^3.6.3"
  }
}

jsdoc.json

Check "opts" in jsdoc.json

{
    "source": {
      "include": ["src"],
      "includePattern": ".js$",
      "excludePattern": "(node_modules/|docs)"
    },
    "plugins": ["plugins/markdown"],
    "templates": {
      "cleverLinks": true,
      "monospaceLinks": true
    },
    "opts": {
      "recurse": true,
      "destination": "./docs/",
      "tutorials": "./tutorials",
      "readme": "./readme.md"
    }
  }

Tutorial pages could be either

  1. html : which gives more control on output
  2. markdown : which gives ease to create docs

END OF readme.md

index.js