Redocly/redoc

mirror of https://github.com/Redocly/redoc.git synced 2024-11-11 03:16:48 +03:00

📘 OpenAPI/Swagger-generated API Reference Documentation

api-documentation documentation-generator documentation-tool hacktoberfest openapi openapi3 openapi31 openapi-specification reactjs redoc starred-redocly-repo starred-repo swagger

Go to file

Roman Hotsiy f407d656f1 markdown table styling		2016-01-23 01:27:46 +02:00
build	Minor Travis fixes	2016-01-17 21:05:52 +02:00
demo	Improve demo page sticky header	2016-01-23 00:00:41 +02:00
lib	markdown table styling	2016-01-23 01:27:46 +02:00
tests	update e2e to pass with responsive menu	2016-01-21 17:27:20 +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	Deploy only after unit tests	2016-01-20 19:24:05 +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	v0.3.0	2016-01-20 18:34:10 +02:00
protractor.conf.js	Uncomment firefox in protractor conf	2016-01-21 18:54:13 +02:00
README.md	Update and add badges	2016-01-17 22:19:48 +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

Swagger-generated API Reference Documentation

Under development

Running locally

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