node-scripts-docs
Advanced tools
This is a yarn Zero-Install repository. After cloning it, you should be ready to use the code. Just in case some dependencies need to be rebuilt, run an install:
yarn install
You can now run node-scripts-docs from the shell through yarn:
yarn nsd --check-only
To run nsd on another project, you can simply pass the directory as an unlabeled argument:
yarn nsd ~/projects/myrepo --check-only
Drop the --check-only to write the initial documentation scaffold. Then begin editing the descriptions in the generated documentation fragments right away.
Whenever you've added scripts, removed scripts, updated documentation fragments, just run yarn nsd again to update the documentation.
FAQs
Generate documentation for your `package.json` scripts.
The npm package node-scripts-docs receives a total of 343 weekly downloads. As such, node-scripts-docs popularity was classified as not popular.
We found that node-scripts-docs demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
/Security News
Threat actors hijacked Toptal’s GitHub org, publishing npm packages with malicious payloads that steal tokens and attempt to wipe victim systems.
Research
/Security News
Socket researchers investigate 4 malicious npm and PyPI packages with 56,000+ downloads that install surveillance malware.
Security News
The ongoing npm phishing campaign escalates as attackers hijack the popular 'is' package, embedding malware in multiple versions.