From 239a0ef8d06214760d5edd9b016c6992fd7e2a94 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Toni=20Matkovi=C4=87?= Date: Thu, 7 Nov 2019 15:47:01 +0100 Subject: [PATCH] README update --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 69d24572..9601c3f0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@
ReDoc logo - +expandResponses **OpenAPI/Swagger-generated API Reference Documentation** [![Build Status](https://travis-ci.org/Redocly/redoc.svg?branch=master)](https://travis-ci.org/Redocly/redoc) [![Coverage Status](https://coveralls.io/repos/Redocly/redoc/badge.svg?branch=master&service=github)](https://coveralls.io/github/Redocly/redoc?branch=master) [![dependencies Status](https://david-dm.org/Redocly/redoc/status.svg)](https://david-dm.org/Redocly/redoc) [![devDependencies Status](https://david-dm.org/Redocly/redoc/dev-status.svg)](https://david-dm.org/Redocly/redoc#info=devDependencies) [![npm](http://img.shields.io/npm/v/redoc.svg)](https://www.npmjs.com/package/redoc) [![License](https://img.shields.io/npm/l/redoc.svg)](https://github.com/Redocly/redoc/blob/master/LICENSE) @@ -248,6 +248,7 @@ You can use all of the following options with standalone version on tag * `suppressWarnings` - if set, warnings are not rendered at the top of documentation (they still are logged to the console). * `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!** +* `disableInfiniteScroll` - if set, each endpoint content will be rendered individually within api-content instead of rendering the whole content in a single-page fashion. Useful for very large endpoint groups. ## Advanced usage of standalone version Instead of adding `spec-url` attribute to the `` element you can initialize ReDoc via globally exposed `Redoc` object: