1.0.45 • Published 5 years ago
node2docfx v1.0.45
Node2DocFX
An API documentation generator for JavaScript.
Using JSDoc to generate YAML files, using DocFX to generate site.
Installation and Usage
To install the latest version available on NPM:
npm install node2docfx
Create a node2docfx.json
for your project:
{
"source": {
"include": ["main.js"]
},
"package": "package.json",
"readme": "/README.md",
"destination": "out"
}
source
: determine what files Node2DocFX generates YAML for. It has exactly the same syntax with that in JSDoc.package
: specify the path ofpackage.json
. The package's name is used as part of theuid
in generated YAML.readme
: specify the path ofREADME.md
. It will be copied to output along with generated YAML.destination
: specify the output folder. Run Node2DocFX locally
node node_modules/node2docfx/node2docfx.js node2docfx.json
1.0.45
5 years ago
1.0.44
6 years ago
1.0.43
6 years ago
1.0.42
6 years ago
1.0.41
6 years ago
1.0.40
6 years ago
1.0.39
6 years ago
1.0.38
6 years ago
1.0.37
6 years ago
1.0.36
6 years ago
1.0.35
6 years ago
1.0.34
7 years ago
1.0.33
7 years ago
1.0.32
7 years ago
1.0.31
7 years ago
1.0.30
7 years ago
1.0.29
7 years ago
1.0.28
7 years ago
1.0.27
7 years ago
1.0.26
7 years ago
1.0.25
7 years ago
1.0.24
7 years ago
1.0.23
7 years ago
1.0.22
7 years ago
1.0.21
7 years ago
1.0.20
7 years ago
1.0.19
7 years ago
1.0.18
7 years ago
1.0.17
7 years ago
1.0.16
7 years ago
1.0.15
7 years ago
1.0.14
7 years ago
1.0.13
7 years ago
1.0.12
7 years ago
1.0.11
7 years ago
1.0.10
7 years ago
1.0.9
7 years ago
1.0.8
7 years ago
1.0.7
7 years ago
1.0.6
7 years ago
1.0.5
7 years ago
1.0.4
7 years ago
1.0.2
7 years ago
1.0.1
7 years ago
1.0.1-rc.1
7 years ago
1.0.0
7 years ago