How to generate JSDoc documentation for a TypeScript React project
2 min readSep 23, 2021
- First, ignore docs folder, if you don’t want docs to be in the repository by adding:
/docs to .gitignore file
2. Create a file called jsdoc.conf.json with this content:
{
"tags": {
"allowUnknownTags": true,
"dictionaries": ["jsdoc", "closure"]
},
"source": {
"include": ["src"],
"includePattern": "\\.(jsx|js|ts|tsx)$",
"excludePattern": "(^|\\/|\\\\)_"
},
"plugins": ["plugins/markdown", "better-docs/component"…