diff --git a/README.md b/README.md index 81b78d36..69d24572 100644 --- a/README.md +++ b/README.md @@ -223,30 +223,31 @@ ReDoc makes use of the following [vendor extensions](https://swagger.io/specific ### `` options object You can use all of the following options with standalone version on tag by kebab-casing them, e.g. `scrollYOffset` becomes `scroll-y-offset` and `expandResponses` becomes `expand-responses`. -* `untrustedSpec` - if set, the spec is considered untrusted and all HTML/markdown is sanitized to prevent XSS. **Disabled by default** for performance reasons. **Enable this option if you work with untrusted user data!** +* `disableSearch` - disable search indexing and search box. +* `expandDefaultServerVariables` - enable expanding default server variables, default `false`. +* `expandResponses` - specify which responses to expand by default by response codes. Values should be passed as comma-separated list without spaces e.g. `expandResponses="200,201"`. Special value `"all"` expands all responses by default. Be careful: this option can slow-down documentation rendering time. +* `hideDownloadButton` - do not show "Download" spec button. **THIS DOESN'T MAKE YOUR SPEC PRIVATE**, it just hides the button. +* `hideHostname` - if set, the protocol and hostname is not shown in the operation definition. +* `hideLoading` - do not show loading animation. Useful for small docs. +* `hideSingleRequestSampleTab` - do not show the request sample tab for requests with only one sample. +* `jsonSampleExpandLevel` - set the default expand level for JSON payload samples (responses and request body). Special value 'all' expands all levels. The default value is `2`. +* `lazyRendering` - _Not implemented yet_ ~~if set, enables lazy rendering mode in ReDoc. This mode is useful for APIs with big number of operations (e.g. > 50). In this mode ReDoc shows initial screen ASAP and then renders the rest operations asynchronously while showing progress bar on the top. Check out the [demo](\\redocly.github.io/redoc) for the example.~~ +* `menuToggle` - if true clicking second time on expanded menu item will collapse it, default `false`. +* `nativeScrollbars` - use native scrollbar for sidemenu instead of perfect-scroll (scrolling performance optimization for big specs). +* `noAutoAuth` - do not inject Authentication section automatically. +* `onlyRequiredInSamples` - shows only required fields in request samples. +* `pathInMiddlePanel` - show path link and HTTP verb in the middle panel instead of the right one. +* `requiredPropsFirst` - show required properties first ordered in the same order as in `required` array. * `scrollYOffset` - If set, specifies a vertical scroll-offset. This is often useful when there are fixed positioned elements at the top of the page, such as navbars, headers etc; `scrollYOffset` can be specified in various ways: - * **number**: A fixed number of pixels to be used as offset; - * **selector**: selector of the element to be used for specifying the offset. The distance from the top of the page to the element's bottom will be used as offset; - * **function**: A getter function. Must return a number representing the offset (in pixels); + * **number**: A fixed number of pixels to be used as offset. + * **selector**: selector of the element to be used for specifying the offset. The distance from the top of the page to the element's bottom will be used as offset. + * **function**: A getter function. Must return a number representing the offset (in pixels). +* `showExtensions` - show vendor extensions ("x-" fields). Extensions used by ReDoc are ignored. Can be boolean or an array of `string` with names of extensions to display. +* `sortPropsAlphabetically` - sort properties alphabetically. * `suppressWarnings` - if set, warnings are not rendered at the top of documentation (they still are logged to the console). -* `lazyRendering` - _Not implemented yet_ ~~if set, enables lazy rendering mode in ReDoc. This mode is useful for APIs with big number of operations (e.g. > 50). In this mode ReDoc shows initial screen ASAP and then renders the rest operations asynchronously while showing progress bar on the top. Check out the [demo](\\redocly.github.io/redoc) for the example.~~ -* `hideHostname` - if set, the protocol and hostname is not shown in the operation definition. -* `expandResponses` - specify which responses to expand by default by response codes. Values should be passed as comma-separated list without spaces e.g. `expandResponses="200,201"`. Special value `"all"` expands all responses by default. Be careful: this option can slow-down documentation rendering time. -* `requiredPropsFirst` - show required properties first ordered in the same order as in `required` array. -* `sortPropsAlphabetically` - sort properties alphabetically -* `showExtensions` - show vendor extensions ("x-" fields). Extensions used by ReDoc are ignored. Can be boolean or an array of `string` with names of extensions to display -* `noAutoAuth` - do not inject Authentication section automatically -* `pathInMiddlePanel` - show path link and HTTP verb in the middle panel instead of the right one -* `hideLoading` - do not show loading animation. Useful for small docs -* `nativeScrollbars` - use native scrollbar for sidemenu instead of perfect-scroll (scrolling performance optimization for big specs) -* `hideDownloadButton` - do not show "Download" spec button. **THIS DOESN'T MAKE YOUR SPEC PRIVATE**, it just hides the button. -* `disableSearch` - disable search indexing and search box -* `onlyRequiredInSamples` - shows only required fields in request samples. -* `jsonSampleExpandLevel` - set the default expand level for JSON payload samples (responses and request body). Special value 'all' expands all levels. The default value is `2`. -* `menuToggle` - if true clicking second time on expanded menu item will collapse it, default `false` -* `expandDefaultServerVariables` - enable expanding default server variables, default `false` -* `theme` - ReDoc theme. Not documented yet. For details check source code: [theme.ts](https://github.com/Redocly/redoc/blob/master/src/theme.ts) +* `theme` - ReDoc theme. Not documented yet. For details check source code: [theme.ts](https://github.com/Redocly/redoc/blob/master/src/theme.ts). +* `untrustedSpec` - if set, the spec is considered untrusted and all HTML/markdown is sanitized to prevent XSS. **Disabled by default** for performance reasons. **Enable this option if you work with untrusted user data!** ## Advanced usage of standalone version Instead of adding `spec-url` attribute to the `` element you can initialize ReDoc via globally exposed `Redoc` object: