# node-doxide
> A tool for transforming documentation in JavaScript files to markdown.
Latest version **0.0.10** (published 2016-09-20) · MIT license · 0 weekly downloads
## Install
```sh
npm install node-doxide
pnpm add node-doxide
yarn add node-doxide
bun add node-doxide
```
Provides the command `doxide`.
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support; pre 1.0.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 0.0.10 |
| Published | 2016-09-20 |
| First published | 2016-09-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Nick Zuber |
| Maintainers | nickzuber |
| Keywords | documentation, doc, docs, markdown, md, compile |
## Links
- npm: https://www.npmjs.com/package/node-doxide
- Repository: https://github.com/nickzuber/doxide
- Homepage: https://github.com/nickzuber/doxide#readme
- Issues: https://github.com/nickzuber/doxide/issues
- npm.io page: https://npm.io/package/node-doxide
## Dependencies (4)
- [chalk](https://npm.io/package/chalk.md) ^1.1.1
- [bluebird](https://npm.io/package/bluebird.md) ^3.4.6
- [minimist](https://npm.io/package/minimist.md) ^1.2.0
- [node-needle](https://npm.io/package/node-needle.md) ^0.1.7
## Alternatives
- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads
## Recent versions
- 0.0.10 (latest) — 2016-09-20
- 0.0.9 — 2016-09-20
- 0.0.8 — 2016-09-20
- 0.0.7 — 2016-09-20
- 0.0.6 — 2016-09-20
- 0.0.5 — 2016-09-20
- 0.0.4 — 2016-09-20
- 0.0.3 — 2016-09-20
- 0.0.2 — 2016-09-20
- 0.0.1 — 2016-09-20
## README
# Doxide
> A tool for transforming jsDoc style documentation in JavaScript files into API documentation in markdown.
## Quick Access
- Installation
- Usage
- CLI
- doxyfile
- Examples
- FAQ
## Installation
```
$ npm install --save-dev node-doxide -g
```
## Usage
There are a few different approaches for using Doxide for your application. You can either create a `doxyfile.json` to define a set of files to scan and where to write the output to, or you can manually define these arguments in the command line.
```
$ doxide --help
Usage: doxide
Possible could be:
doxide Compiles based on your doxyfile.json
doxide --h Prompts the help screen
doxide --help Prompts the help screen
doxide Compiles
doxide Compiles all valid files in
doxide -o Compiles and stores output in
doxide -o Compiles all valid files in and stores output in
```
### Using CLI arguments
```
$ doxide path/to/file -o path/to/output
```
### Using doxyfile.json
A `doxyfile.json` consists of a few main fields:
- targets
- output
The `targets` field consist of an array of files that are to be parsed by Doxide. Being an array, it can consist of a single file or multiple files. You can also include a path to a directory here, and it's important to note that the directory will include all subdirectories within.
The `output` field is a single string of the name of the file to write the output to. If no output destination is specified, the compiler will default to writing the output to the console.
Example of the `doxyfile.json` being used for [Needle](https://github.com/nickzuber/needle) which parses every source file and then stores the results into a single markdown file:
```json
{
"targets" : [
"./src"
],
"output" : "./docs/doxide_output.md"
}
```
## Examples
Using a `doxyfile.json`
```
$ cd root/director/with/doxyfile
$ doxide
```
Using the cli arguments
```
$ doxide main.js component.jsx router.js -o docs/output.md
[02:03:28] Attempting to fetch files
[02:03:28] Working on 3 files
[02:03:28] Cleared docs/output.md prepping for output
[02:03:28] Successfully wrote all of main.js documention from to output.md
[02:03:28] Successfully wrote all of component.jsx documention from to output.md
[02:03:28] Successfully wrote all of router.js documention from to output.md
[02:03:28] Finished after 15 ms
```
## FAQ
### Skipped over one or more comment blocks in .... due to missing fields.
While parsing through the documentation comments in a file, sometimes there hasn't been enough information provided for a particular block to be able to fill out the markdown function template. When this happens, we simply skip over that block and let you know that we've done so.
"Missing fields" could be something like a documentation block that wasn't given a function to document, but for things like a missing type definition in a `param` tag, we will throw an error.
### Unable to access the file ./.../.....md
If you try to set your output destination to a file within a directory that doesn't yet exist, we'll throw an error. Sending the output to a non existent file is fine, so long as we can _get_ there. The directory must first exist.
## License
[MIT](https://opensource.org/licenses/MIT)
Copyright (c) 2015-Present Nick Zuber
---
_Source: https://npm.io/package/node-doxide · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._