Files

Shahed Nasser 18de90e603 docs: fix tsdocs following typedoc update + 1.20 release (#6033 )

* docs: fix tsdocs following typedoc update + 1.20 release

* Fix OAS validation errors

* fixes to react-docs-generator

* fix content linting

2024-01-09 17:15:29 +02:00

2024-01-09 17:15:29 +02:00

package.json

2024-01-09 11:27:17 +02:00

README.md

2023-12-13 16:02:41 +02:00

tsconfig.json

2023-12-13 16:02:41 +02:00

react-docs-generator

Tool that generates documentation for React components. It's built with react-docgen and Typedoc.

Usage

yarn start --src ./path/to/src --output ./path/to/output/dir

--src <srcPath>: (required) A path to a file containing React components or a directory to scan its sub-directories and files for components.
--output <outputPath>: (required) Path to the directory to store the output in.
--clean: If used, the output directory is emptied before generating the new output.
--tsconfigPath <path>: Path to a TS Config file which is used by Typedoc. By default, the file at docs-util/packages/typedoc-config/extended-tsconfig/ui.json is used.
--disable-typedoc: Whether to disable Typedoc and generate the spec file using react-docgen only. Useful for debugging.
--verbose-typedoc: Whether to show the output of Typedoc. By default, it's disabeld.