Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2024-09-21 03:08:48 +03:00
Code Issues Packages Projects Releases Wiki Activity
📘 OpenAPI/Swagger-generated API Reference Documentation
201 Commits 14 Branches 224 Tags 82 MiB
TypeScript 98.1%
JavaScript 0.8%
Shell 0.4%
HTML 0.4%
Dockerfile 0.3%
7d578b85e5
Go to file
Roman Hotsiy 7d578b85e5 Add JsonPipe to component pipes
2015-12-19 02:24:44 +02:00
build Handle scss in tests 2015-12-19 00:53:33 +02:00
demo Rename x-secondaryTag to x-traitTag 2015-12-01 00:29:01 +02:00
lib Add JsonPipe to component pipes 2015-12-19 02:24:44 +02:00
tests ApiInfo component spec 2015-12-18 10:36:01 +02:00
.eslintignore Updated eslint 2015-12-12 22:10:59 +02:00
.eslintrc Migrate tests to jasmine instead of macha (angular testing depends on jasmine) 2015-12-18 10:34:17 +02:00
.gitignore Setup coverage and coveralls 2015-12-13 12:37:58 +02:00
.travis.yml Update Travis env variable 2015-12-13 12:49:10 +02:00
gulpfile.js Initial configuration + build tasks 2015-10-03 12:38:41 +03:00
karma.conf.js Handle scss in tests 2015-12-19 00:53:33 +02:00
LICENSE Update LICENSE 2015-10-30 07:56:43 -05:00
package.json Handle scss in tests 2015-12-19 00:53:33 +02:00
README.md Add coverage status badge 2015-12-13 12:56:29 +02:00
system.config.js Update angular2 to the latest alpha + migrate 2015-12-14 17:20:40 +02:00

README.md

ReDoc

travis-ci-status ![coverage-status-badge] license-badge

Swagger-generated API Reference Documentation

Under development

[Live demo][demo]

Running locally

  1. Clone repository git clone https://github.com/Rebilly/ReDoc.git
  2. Go to the project folder cd ReDoc
  3. Install node modules npm install
  4. (optional) Replace demo/swagger.json with your own schema
  5. Start the server npm start
  6. Open http://localhost:9000

[coverage-status-badge]:https://coveralls.io/repos/Rebilly/ReDoc/badge.svg?branch=master&service=github) "Coverage Status" [demo]: http://rebilly.github.io/ReDoc/