Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2024-09-21 11:18:48 +03:00
Code Issues Packages Projects Releases Wiki Activity
📘 OpenAPI/Swagger-generated API Reference Documentation
283 Commits 14 Branches 224 Tags 82 MiB
TypeScript 98.1%
JavaScript 0.8%
Shell 0.4%
HTML 0.4%
Dockerfile 0.3%
abfd363401
Go to file
Roman Hotsiy abfd363401 Temporal referencing fix
2016-01-16 23:25:12 +02:00
build Add basic e2e tests 2016-01-15 22:34:28 +02:00
demo add html5 doctype and fix strictmode issues 2016-01-12 01:26:47 +02:00
lib Temporal referencing fix 2016-01-16 23:25:12 +02:00
tests Handle circular references 2016-01-16 00:44:10 +02:00
.codeclimate.yml fix codeclimate config 2015-12-26 19:47:35 +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
.npmignore prepare for npm publish 2016-01-12 23:36:23 +02:00
.travis.yml prepare for npm publish 2016-01-12 23:36:23 +02:00
bower.json setup branch-release 2016-01-06 17:22:17 +02:00
gulpfile.js Initial configuration + build tasks 2015-10-03 12:38:41 +03:00
karma.conf.js Add basic e2e tests 2016-01-15 22:34:28 +02:00
LICENSE Update LICENSE 2015-10-30 07:56:43 -05:00
package.json Force json-schema-ref-parser to the latest version 2016-01-16 00:43:41 +02:00
protractor.conf.js clarify e2e tests output 2016-01-15 23:26:54 +02:00
README.md Add codeclimate badge 2015-12-24 14:50:08 +02:00
system.config.js Force json-schema-ref-parser to the latest version 2016-01-16 00:43:41 +02:00

README.md

ReDoc

travis-ci-status ![coverage-status-badge] ![code-climate-badge] ![dev-dependency-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" [dev-dependency-badge]: https://david-dm.org/Rebilly/ReDoc/dev-status.svg [code-climate-badge]: https://codeclimate.com/github/Rebilly/ReDoc/badges/gpa.svg "Code Climate" [demo]: http://rebilly.github.io/ReDoc/