bouquet
Advanced tools
Readme
A collection of plugins for JSDoc, that can be readily integrated with JSDoc installations to extend the functionalities of JSDoc without editing the core of JSDoc.
Often we need to extend JSDoc to support different use cases that are not satisfied by JSDoc. For example, someone might need to include additional files in their documentation, or parse additional directives.
JSDoc exposes a plugins architecture that can be used to address those use cases, without hacking on the core JSDoc files. Bouquet is an effort to provide a unified collection of such useful plugins for use with JSDoc.
Each plugin in Bouquet is contained in a separate directory within the src directory. Generic instruction for using a Bouquet plugin is:
Clone the Bouquet repository.
Copy plugin directory from src directory to the plugins directory in JSDoc's installation directory.
Edit JSDoc's conf file and add path to the plugin in the plugins array. For example, if you want to use the staticFiles plugin and have copied src/staticFiles to JSDoc's plugins/staticFiles directory, then your plugins array would contain:
"plugins": ["plugins/staticFiles/staticFiles"]
Put in plugin specific configuration in JSDoc's conf file. Each plugin's configuration options are provided in a README.md within the plugin specific folder.
You are all set!
Copies static files in source to generated documentation based on user-specified include paths, inclusion and exclusion patters, with support for recursive copying. [Know more]
FAQs
Collection of useful plugins for JSDoc
We found that bouquet demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers 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
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.