Skip to content
nene edited this page Aug 8, 2012 · 4 revisions

Instead of listing oh-so-many JSDuck options on command line you can create a JSON config file like this:

{
    "--title": "My personal docs",
    "--welcome": "welcome.html",
    "--warnings": ["-link", "-no_doc"],
    "--": [
        "src/Foo.js",
        "src/Bar.js",
        "src/Baz.js"
    ]
}

Note that all the listed paths will be taken relative to the config file itself. The special "--" option is for passing the input files.

You pass this file to JSDuck using the --config option:

$ jsduck --config=myconfig.json

The result is as if you had called JSDuck with the following options:

$ jsduck --title="My personal docs" \
         --welcome="welcome.html" \
         --warnings=-link \
         --warnings=-no_doc \
         src/Foo.js src/Bar.js src/Baz.js
Clone this wiki locally