Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2024-11-26 10:33:44 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Roman Hotsiy 2016-07-29 18:20:38 +03:00 committed by GitHub
parent 5f044b900f
commit bc47b40466
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -97,7 +97,7 @@ ReDoc makes use of the following [vendor extensions](http://swagger.io/specifica
* **number**: A fixed number of pixels to be used as offset; * **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; * **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); * **function**: A getter function. Must return a number representing the offset (in pixels);
* `suppress-warnings` - if set, warnings are not rendered at the top of page (they still are logged to the console). * `suppress-warnings` - if set, warnings are not rendered at the top of documentation (they still are logged to the console).
## Advanced usage ## Advanced usage
Instead of adding `spec-url` attribute to the `<redoc>` element you can initialize ReDoc via globally exposed `Redoc` object: Instead of adding `spec-url` attribute to the `<redoc>` element you can initialize ReDoc via globally exposed `Redoc` object:
@ -105,12 +105,13 @@ Instead of adding `spec-url` attribute to the `<redoc>` element you can initiali
Redoc.init(specUrl, options) Redoc.init(specUrl, options)
``` ```
`options` is javascript object with camel-cased version of options names as the keys. For example: `options` is javascript object with camel-cased version of options names as the keys, e.g.:
```js ```js
Redoc.init('http://petstore.swagger.io/v2/swagger.json', { Redoc.init('http://petstore.swagger.io/v2/swagger.json', {
scrollYOffset: 50 scrollYOffset: 50
}) })
``` ```
----------- -----------
## Running locally ## Running locally
1. Clone repository 1. Clone repository