Docblock parser with custom tags. Automatically generates markdown files.
Allows any type of docblock tag e.g. @param, @option, @foo, @bar
npm install -g foxydoc
foxydoc --included-paths foo bar --exclude-pattern demo --output-directory docs
| Name | Type | Description |
|---|---|---|
--included-paths | Array | Paths to generate from |
--exclude-pattern | String | Regex pattern to exclude |
--output-directory | String | Location of markdown output |
FAQs
Docblock parser with custom tags
We found that foxydoc 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.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.