create markdown docs for dox output
doxme([example="foo"])A Markdown formatter for dox. Takes dox's JSON output as stdin and writes Markdown to stdout.
dox -r < index.js | doxme
| parameter | type | description |
|---|---|---|
[example="foo"] | String | optional: this is just an example parameter |
// this is just an example example
var foo = 2 * 2;
Requires nodejs.
$ npm install doxme
$ npm test
FAQs
create markdown docs for dox output
The npm package doxme receives a total of 151 weekly downloads. As such, doxme popularity was classified as not popular.
We found that doxme 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.
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.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.