Security News
Namecheap Takes Down Polyfill.io Service Following Supply Chain Attack
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
jsd-jekyll
Advanced tools
Changelog
0.1.0 - 2021-02-09
Readme
A JSDOC Plugin and Template to generate a GitHub Pages compatible Jekyll Documentation Site from jsdoc comments.
npm install --save-dev jsd-jekyll
Add "./node_modules/jsd-jekyll"
as a plugin and template in your jsdoc config file.
Example:
{
"opts": {
"template": "./node_modules/jsd-jekyll",
"destination": "./out/",
"recurse": true
},
"plugins": ["./node_modules/jsd-jekyll"]
}
Optionally a link to your source code on GitHub can be added to the documentation. Under opts in the jsdoc config file add:
"opts": {
"repos" : [{
"folder": "folderName",
"name": "user/repo"
}]
}
Multiple repos can be added to the array to support sub repositories based on the file path of the source code.
Basic @jsdoc tags should work as documented. Not all currently work with this template, more will be added over time.
The following custom tags can be added.
@category
A category can be added to a @module
comment block to organize modules. Each category will create an index page with the relevant modules linked to the main api index.
Modules without a @category
tag will display on the api index.
@route
Use @route to document api routes in the following format
/**
/* @route {GET} /api/path description...
*/
Add parameters using the appropriate param tag (@routeparam
, @headerparam
, @bodyparam
, or @queryparam
). All follow the @param
fromat ({type} name description
)
When using a module as a return or parameter type preface the module name with module:
Example:
/**
/* @param {module:myMod1} paramName description of the parameter
/* @returns {module:myMod2} description of the return
*/
To run Jekyll locally (requires ruby):
bundle install
bundle exec jekyll serve
Only /_data/jsdoc.json
will be overwritten when running jsdoc a second time. Other files can be customized as needed. To reset them, delete and run jsdoc.
FAQs
JSDoc Plugin and Template for making a Github Pages compatable Jekyll Site
The npm package jsd-jekyll receives a total of 1 weekly downloads. As such, jsd-jekyll popularity was classified as not popular.
We found that jsd-jekyll demonstrated a not healthy version release cadence and project activity because the last version was released 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.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.
Security News
A JavaScript library maintainer is under fire after merging a controversial PR to support legacy versions of Node.js.