[Enhancement] Missing Documentation of "extends" and "configuration in js" features

[JamesWang0210]

Search Terms

• Typedoc
• Documentation of Features

Problem

Hi team,

I am using typedoc to generate docs from typescript based packages in React. While reading the following two issues, I learned that typedoc is currently supporting to use extends as one field in configuration. Also, typedoc.js is supported as one form of configuration for use as well.

• Support typedoc.json "extends" #493
• typedoc.js vs typedoc.json configuration files in documentation #1029

I would like to know why both of them are not documented officially. I can not find either of them on the typedoc webiste: https://typedoc.org/guides/installation/. Is it because any of them will be removed in the near future? Since I am going to use either of these features in long-term run, I would like to know the thoughts from typedoc team. Please let me know if there are any deprecation plans of them. Thank you.

Dependencies Version

• typescript: ^3.9.x
• typedoc: ^0.22.10
• typedoc-plugin-markdown: ^3.11.8

Suggested Solution

It would be better to document these useful features if typedoc team is going to keep them in the future revisions.

[Gerrit0]

JS configuration is documented: http://typedoc.org/guides/options/#options-1

Missing extends is an oversight - PR welcome!

[JamesWang0210]

Thank you Gerrit @Gerrit0 What I mean is there is no official example of JS configuration documented. See if it is possible to provide some, even though I understand officially typedoc team prefers users to use configruation in JSON.