Search code examples
jsdocjsdoc3

How can I omit the source links in JsDoc?

What's the easiest way to cause JsDoc to leave out the source links? Do I have to define my own template?

Solution

  • If you use the default template, then use a configuration file with templates.default.outputSourceFiles set to false. For instance:

    {
    "templates": {
        "default": {
            "outputSourceFiles": false
        }
    }
}

    You'd pass the path to this file to jsdoc using the -c option on the command line.

    I don't see this option documented in any actual jsdoc documentation. I've found it mentioned in this issue and this one.

    The template is the entity providing this functionality so if you use another template than the default one, you have to check its documentation to find whether there is a setting you can set to do this.