Files

github-actions[bot] 423b6d94dc chore(docs): Updated UI Reference (automated) (#13968 )

* chore(docs): Generated + Updated UI Reference (automated)

* fix react-docs-generator not resolving external types

* sort undefined

---------

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>

2025-11-05 18:00:46 +02:00

src

chore(docs): Updated UI Reference (automated) (#13968 )

2025-11-05 18:00:46 +02:00

package.json

docs: migrate UI docs (#13245 )

2025-08-20 11:42:25 +03:00

README.md

chore: move docs-util to www (#7232 )

2024-05-06 09:13:50 +03:00

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.