Skip to main content

TypeDoc.json

TypeDoc makes building documentations very easy. It can fit into most codebases with minimal setup. TypeDoc extracts & builds documentation from typescript types , interfaces,.. and also makes use javascript doc comments.

Install dependencies:


npm i typedoc -d
yarn add typedoc -d
//installing as dev dependency


After installation , create a "typedoc.json" in the root path.

Find more resources here https://typedoc.org/options/configuration/

Configuration file I have customised https://github.com/808vita/nextjs-blog-with-auth/blob/deploy/typedoc.json

Repository GitHub link : Full repository github - 808vita -oofdev


Comments

Topics

Show more