Security News
Highlights from the 2024 Rails Community Survey
A record 2,709 developers participated in the 2024 Ruby on Rails Community Survey, revealing key tools, practices, and trends shaping the Rails ecosystem.
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"]
}
repos
{ array }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.
includeAll
{ boolean } default falseThis will tag all files processed with @module filename
if no @module
tag is present.
functionFix
{ boolean } default false@function myFunction()
becomes @function myFunction
.@function
tag
/**
* @function myFunction
* This is a description in the wrong place.
*/
Changes to
/**
* @function myFunction
* @description This is a description in the wrong place.
*/
folderCategory
{ boolean } default false/api/main/index.js
will be tagged @category api-main
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.
0.2.0 - 2021-04-01
@function
tag usageFAQs
JSDoc Plugin and Template for making a Github Pages compatable Jekyll Site
The npm package jsd-jekyll receives a total of 0 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
A record 2,709 developers participated in the 2024 Ruby on Rails Community Survey, revealing key tools, practices, and trends shaping the Rails ecosystem.
Security News
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.