Files

Shahed Nasser 4ffcc41fe7 chore(utils): update auth provider TSDocs + fix errors stopping references build (#9023 )

- Updated the TSDocs of the auth provider
- Update the Node version in the docs-util as the outdated version was causing TypeScript error
- Add `@ts-ignore` for a line that was causing a typescript error. If there's a better fix here let me know

2024-09-09 13:53:33 +00:00

src

…

package.json

chore(utils): update auth provider TSDocs + fix errors stopping references build (#9023 )

2024-09-09 13:53:33 +00:00

README.md

…

tsconfig.json

docs-util: Upgrade typedoc to 0.26 (#7853 )

2024-06-27 10:52:44 +00:00

README.md

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

Options

--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 www/utils/packages/typedoc-config/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.