Dox is a JavaScript documentation generator written for node.
Dox is a 2 hour product of my frustration with documentation generators. I wanted something that could parse my JavaScript using markdown and JSDoc tags, an easy to use executable, as well as a single deployment file, no external css or js, one file!
doxInstall from npm:
$ npm install dox@latest
Install from git clone or tarball:
$ make install
Simple example:
$ dox --title Connect lib/connect/index.js
Lots of files:
$ dox --title Connect --desc "markdown _here_" $(file lib/* -type f) > docs.html
Output from --help:
Usage: dox [options] <file ...>
Options:
-t, --title Project title
-d, --desc Project description (markdown)
-s, --style Document style, available: ["default"]
-J, --no-jsdoc Disable jsdoc parsing (coverts to markdown)
-p, --private Output private code in documentation
-h, --help Display help information
FAQs
Markdown / JSdoc documentation generator
We found that dox demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 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
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.
Security News
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.