From 6477ae341188d9288f7e5fceb6e977706d9ab67d Mon Sep 17 00:00:00 2001 From: Max Date: Mon, 21 Oct 2024 13:35:18 +0100 Subject: [PATCH] docs: update README.md to master React Component Docs (#689) Co-authored-by: Lukasz Gornicki --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c932eedae..2611b10b9 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ Look into [Releases](/asyncapi/html-template/releases) of this template to pick | pdf | Generates output HTML as PDF. | No | `false` | `true`, `false` | `true` | | pdfTimeout | Timeout (in ms) used to generate the PDF. | No | 30000 | >=0 | 1000 | | favicon | Defines the URL/Path used for the favicon. | No | `assets/asyncapi-favicon.ico` | Any valid favicon URL/Path. | `"https://studio.asyncapi.com/favicon.ico"` | -| config | Inline stringified JSON or a path to a JSON file to override default React component config. The config override is merged with the default config using the [JSON Merge Patch](https://tools.ietf.org/html/rfc7386) algorithm. | No | `{ "show": { "sidebar": true }, "sidebar": { "showOperations": "byDefault" } }` | [JSON config for the React component](https://github.com/asyncapi/asyncapi-react/blob/next/docs/configuration/config-modification.md#definition) | `{"show":{"sidebar":false}}` | +| config | Inline stringified JSON or a path to a JSON file to override default React component config. The config override is merged with the default config using the [JSON Merge Patch](https://tools.ietf.org/html/rfc7386) algorithm. | No | `{ "show": { "sidebar": true }, "sidebar": { "showOperations": "byDefault" } }` | [JSON config for the React component](https://github.com/asyncapi/asyncapi-react/blob/master/docs/configuration/config-modification.md#definition) | `{"show":{"sidebar":false}}` | > **NOTE**: If you only generate an HTML website, set the environment variable `PUPPETEER_SKIP_CHROMIUM_DOWNLOAD` to `true` and the generator will skip downloading chromium.