Generating Typedoc for Angular Package Format Projects | Task

Ole Ersoy
Oct - 14  -  1 min

Scenario

We've created an Angular Package Format project for our library for our project fs-validatorts and now we want to generate Typedoc into the folder doc project root folder.

Approach

First add skipLibCheck to the compilerOptions in tsconfig.json:

"skipLibCheck": true,

Then add a doc script to package.json:

"doc": "rm -fr doc && typedoc --entryPointStrategy expand ./projects/fs-validatorts/src/lib --out doc --exclude **/*.spec.ts"

Running npm run doc now produces the Typedoc. To see the generated documents run:

http-server -o doc

Add an sdoc script to run the typedoc generation and serve / open the result in the browser:

"sdoc": "npm run doc && http-server -o doc"