245e5c9a69
* added tool to generate spec files for React components * use typedoc for missing descriptions and types * improvements and fixes * improvements * added doc comments for half of the components * add custom resolver + more doc comments * added all tsdocs * general improvements * add specs to UI docs * added github action * remove unnecessary api route * Added readme for react-docs-generator * remove comment * Update packages/design-system/ui/src/components/currency-input/currency-input.tsx Co-authored-by: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com> * remove description of aria fields + add generate script --------- Co-authored-by: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com>
18 lines
978 B
Markdown
18 lines
978 B
Markdown
# react-docs-generator
|
|
|
|
Tool that generates documentation for React components. It's built with [react-docgen](https://react-docgen.dev/) and [Typedoc](https://typedoc.org/).
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
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 `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. |