explain_me v1.5.23

explain_me

Play with docs

Instructions:

npm install explain_me
const explain_me =  require('explain_me')

If utilizing in html...:

<script src="./node_modules/explain_me/index.js"></script>
<script> 
$(()=> { 
     const output =  explain_me.method(parameter)
 })
</script>

Functions

moveToDeploy(deployDependencies, zen_out, final) ⇒ any

Kind: global function
Date: 2022-03-10
Author: zen-out

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"
})

init(moduleName) ⇒ any

init(moduleName)

Kind: global function
Date: 2022-03-23
Author: zen-out

docs(moduleName, folderName, from, to, intro) ⇒ any

docs(moduleName, folderName, from, to, intro)

Kind: global function
Date: 2022-03-23
Author: zen-out

html(moduleName, video)

• Removes jsdoc.json file
• Replaces module and video link
• Runs jsdoc

Kind: global function
Date: 2022-03-08
Author: zen-out

Example

html(moduleName, videoLink)

copyHTML(from, location) ⇒ any

Kind: global function
Date: 2022-03-22
Author: zen-out

Example

copyHTML("./docs/global.html", "../zen-out.github.io/modules/moduleName.html")

readme(moduleName, video)

Kind: global function
Date: 2022-03-08
Author: zen-out

Example

readme(moduleName, docsLink, "intro.md")

addScript(moduleName) ⇒ any

Adds info

Kind: global function
Date: 2022-03-22
Author: zen-out