Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
A customized Minami template for RAC — Ruler and Compass.
Install into devDependencies
$ npm install --save-dev jsdoc
$ npm install --save-dev minami-rac
In your .jsdoc.json
file, add a template option.
"opts": {
"template": "node_modules/minami-rac"
}
In your projects package.json
file add a generate script:
"scripts": {
"generate-docs": "node_modules/.bin/jsdoc --configure .jsdoc.json --verbose"
}
templates
JSDoc Configuration{
"templates": {
"minami" : {
"homeNavItem": "Minami-RAC",
"versionNavItem": "1.4.0",
"showInheritedInNav": false,
"showMethodsInNav": false,
"showMembersInNav": false
},
"default" : {
"cleverLinks": false,
"monospaceLinks": false,
"includeDate" : false,
"useLongnameInNav": 3,
}
}
minami.showInheritedInNav
- When set to true
lists the inherited methods and members in the navigation sidebar of the pages of classes and namespaces; otherwise these elements are hiddenminami.showMethodsInNav
- When set to true
lists the methods of classes and namespaces in the navigation sidebar of all pages; otherwise these elements are hiddenminami.showMembersInNav
- When set to true
lists the members of classes and namespaces in the navigation sidebar of all pages; otherwise these elements are hiddendefault.useLongnameInNav
- Using an integer will display at most that amount of path elements in the navigation sidebar, any omited path is replaced with ellipsis; true
displays the full longname, false
is equivalent to 0
which displays only the last element without any ellipsisMinami-RAC is licensed under the MIT License.
Minami and JSDoc 3 are licensed under the Apache2 license.
FAQs
Customized Minami template for RAC
We found that minami-rac 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
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.