From e1e596f44f85d559957115152c945980a2072668 Mon Sep 17 00:00:00 2001 From: Roman Hotsiy Date: Sun, 24 Jan 2016 23:15:50 +0200 Subject: [PATCH] Add deployment docs (fixes #10) --- README.md | 85 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 83 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b4f9343e..98367ea5 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,91 @@ Swagger-generated API Reference Documentation -**Under development** - [Live demo](http://rebilly.github.io/ReDoc/) +## Deployment + +## tl;dr +```html + + + + ReDoc + + + + + + + + + + + + +``` + +#### 1. Install redoc +Install using [bower](bower.io): + + bower install redoc + +or using [npm](https://docs.npmjs.com/getting-started/what-is-npm): + + npm install redoc --save + +Alternatively you can just download [`redoc.min.js`](https://raw.githubusercontent.com/Rebilly/ReDoc/releases/dist/redoc.min.js). + +#### 2. Reference redoc script in HTML +Then reference [`redoc.min.js`](https://raw.githubusercontent.com/Rebilly/ReDoc/releases/dist/redoc.min.js) in your HTML page: +```html + +``` +For npm: +```html + +``` + +#### 3. Add `` element to your page +```html + +``` + +#### 4. Enjoy :smile: + +## Configuration + +* `spec-url` - relative or absolute url to your spec file +* `scroll-y-offset` - 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. +`scroll-y-offset` 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). + +## Advanced usage +Instead of adding `spec-url` attribute to the `` element you can initialize ReDoc via globally exposed `Redoc` object: +```js +Redoc.init(specUrl, options) +``` + +`options` is javascript object with camel-cased versions of options names as the keys. For example: +```js +Redoc.init('http://petstore.swagger.io/v2/swagger.json', { + scrollYOffset: 50 +}) +``` +----------- ## Running locally 1. Clone repository `git clone https://github.com/Rebilly/ReDoc.git`