A docco-like formatter for the dox comment parser using Dust.js
npm install -g dox-docco
For pygments support, install python-setuptools, then
sudo easy_install pygments
If pygments is not installed, syntax highlighting will be skipped.
Usage: dox-docco [options]
Options:
-h, --help output usage information
-V, --version output the version number
-o, --outfile [outfile] the file to output to. Default is stdout
-i, --infile [infile] the file to read in. Deafult is stdin
-c, --css [css] The css file to use. Default is github hosted static/docco.css.
-t, --template [template] The dust template to use. Default is static/template.html.
--title [title] The title of the output document. Deafult is the input file name, or '' for stdin
Dox parses block style JS comments, while Docco parses single-line comments. In effect, this is Docco for block-style comments. I also wanted to create an example Dox template using Dust.js. This basically glues these 3 technologies together.
FAQs
A docco-like formatter for the dox comment parser
We found that dox-docco 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.