Skip to content

Instantly share code, notes, and snippets.

@svierk
Created April 9, 2022 13:13
Show Gist options
  • Save svierk/cda85df53b3c8f1cde0b3e63801f0113 to your computer and use it in GitHub Desktop.
Save svierk/cda85df53b3c8f1cde0b3e63801f0113 to your computer and use it in GitHub Desktop.
Configuration file for generating LWC code documentation using JSDoc
{
"tags": {
"allowUnknownTags": true,
"dictionaries": ["jsdoc", "closure"]
},
"source": {
"include": ["force-app/main/default/lwc"],
"includePattern": ".+\\.js(doc|x)?$",
"excludePattern": "(^|\\/|\\\\)_"
},
"plugins": [],
"templates": {
"cleverLinks": false,
"monospaceLinks": false
},
"opts": {
"destination": "docs",
"recurse": true,
"readme": "README.md"
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment