This is a
playground to test code. It runs a full
Node.js environment and already has all of
npm’s 400,000 packages pre-installed, including
add-jsdocs-here with all
npm packages installed. Try it out:
add-jsdocs-here lists no main file and has no index.js, so it can't be directly required. If this is a mistake, please let us know. It may however contain internal files that you can require manually:
This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.
Simple npm package that adds the required files and configurations to generate documentation using jsdoc3.
Just run it on the root folder of the project that you want to be patched for jsdoc3.
A wizzard will guide you across all the configurations. Most of the defaults are fine for many projects, but you want to put special attention to the following:
The documentation generation require
gulp to be installed globally and locally and
This is not required by the module to work, but they will be required for generate the documentation.
The module will ask you if you want to install the required dependencies and will install them for you,
except for the global
gulp which has to be installed manually..
I recommend you to install it globally. You are not going to use it twice for the same project, but it may be useful for several projects. That's why I recommend to install it globally.
npm install -g add-jsdocs-here