Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
minami-ext
Advanced tools
Readme
A clean, responsive documentation template theme for JSDoc 3.
$ npm install --save-dev minami
Clone repository to your designated jsdoc
template directory, then:
$ jsdoc entry-file.js -t path/to/minami
In your projects package.json
file add a generate script:
"scripts": {
"generate-docs": "node_modules/.bin/jsdoc --configure .jsdoc.json --verbose"
}
In your .jsdoc.json
file, add a template option.
"opts": {
"template": "node_modules/minami"
}
{
"tags": {
"allowUnknownTags": true,
"dictionaries": ["jsdoc"]
},
"source": {
"include": ["lib", "package.json", "README.md"],
"includePattern": ".js$",
"excludePattern": "(node_modules/|docs)"
},
"plugins": [
"plugins/markdown"
],
"templates": {
"cleverLinks": false,
"monospaceLinks": true,
"useLongnameInNav": false,
"showInheritedInNav": true
},
"opts": {
"destination": "./docs/",
"encoding": "utf8",
"private": true,
"recurse": true,
"template": "./node_modules/minami"
}
}
Specifying a number for useLongnameInNav it will be the max number of path elements to show in nav (starting from Class).
This extended version of Minami supports the following options:
{
"minami": {
// Array of external (or relative local copied using templates.default.staticFiles.include) js or css files to inject into HTML,
"scripts": [],
}
}
Licensed under the Apache2 license.
FAQs
Extended version of Minami JSDoc 3/4 theme
The npm package minami-ext receives a total of 7 weekly downloads. As such, minami-ext popularity was classified as not popular.
We found that minami-ext 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.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.