| 1 | # Node2DocFX
|
| 2 | [](https://ci.appveyor.com/project/superyyrrzz/node2docfx/branch/master)
|
| 3 |
|
| 4 | An API documentation generator for JavaScript.
|
| 5 | Using [JSDoc](http://usejsdoc.org/) to generate YAML files, using [DocFX](http://dotnet.github.io/docfx/) to generate siteL
|
| 6 |
|
| 7 | # Installation and Usage
|
| 8 | To install the latest version available on NPM:
|
| 9 | ```
|
| 10 | npm install node2docfx
|
| 11 | ```
|
| 12 | Create a `node2docfx.json` for your project:
|
| 13 | ```json
|
| 14 | {
|
| 15 | "source": {
|
| 16 | "include": ["main.js"]
|
| 17 | },
|
| 18 | "package": "package.json",
|
| 19 | "readme": "/README.md",
|
| 20 | "destination": "out"
|
| 21 | }
|
| 22 | ```
|
| 23 | * `source`: determine what files Node2DocFX generates YAML for. It has exactly the same syntax with that in [JSDoc](http://usejsdoc.org/about-configuring-jsdoc.html#specifying-input-files).
|
| 24 | * `package`: specify the path of `package.json`. The package's name is used as part of the `uid` in generated YAML.
|
| 25 | * `readme`: specify the path of `README.md`. It will be copied to output along with generated YAML.
|
| 26 | * `destination`: specify the output folder.
|
| 27 | Run Node2DocFX locally
|
| 28 | ```
|
| 29 | node node_modules/node2docfx/node2docfx.js node2docfx.json
|
| 30 | ``` |
| \ | No newline at end of file |