7d650771d1
* add new plugin for better organization * added handling in theme for mutations and query types * added tsdoc to hooks * added tsdocs to utility functions * added tsdoc to providers * generated reference * general fixes for generated reference * generated api reference specs + general fixes * add missing import react * split utilities into different directories * added overview page * added link to customer authentication section * fix lint errors * added changeset * fix readme * fixed build error * added expand fields + other sections to overview * updated what's new section * general refactoring * remove unnecessary query field * fix links * added ignoreApi option
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 atdocs-util/packages/typedoc-config/extended-tsconfig/ui.jsonis used.--disable-typedoc: Whether to disable Typedoc and generate the spec file usingreact-docgenonly. Useful for debugging.--verbose-typedoc: Whether to show the output of Typedoc. By default, it's disabeld.