Global

Methods

# copyHTML(from, location) → {any}

Parameters:
Name Type Description
from any
location any
Author:
  • zen-out
Returns:
Type
any
Example
copyHTML("./docs/global.html", "../zen-out.github.io/modules/moduleName.html")

# html(moduleName, video)

  • Removes jsdoc.json file
  • Replaces module and video link
  • Runs jsdoc
Parameters:
Name Type Description
moduleName any

= undefined

video any

= undefined

Author:
  • zen-out
Example
html(moduleName, videoLink)

# moveToDeploy(deployDependencies, zen_out, final) → {any}

Parameters:
Name Type Description
deployDependencies any
zen_out any
final any

= false

Author:
  • zen-out
Returns:
Type
any
Example
moveToDeploy({
    "automate_me": "^1.0.3",
    "clean-jsdoc-theme": "^3.3.3",
    "clear_concise_creative": "^1.0.17",
    "jsdoc": "^3.6.10",
    "jsdoc-to-markdown": "^7.1.1"
})

# readme(moduleName, video)

Parameters:
Name Type Description
moduleName any

= undefined

video any

= undefined

Author:
  • zen-out
Example
readme(moduleName, docsLink, "intro.md")