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
66 Commits 14 Branches 224 Tags 82 MiB
TypeScript 98.1%
JavaScript 0.8%
Shell 0.4%
HTML 0.4%
Dockerfile 0.3%
c7bc6ff391
Go to file
Roman Gotsiy c7bc6ff391 Add body sample to the right panel
2015-10-25 13:26:38 +02:00
build fix watch task 2015-10-18 18:32:03 +03:00
demo Added rigth panel 2015-10-21 14:07:22 +03:00
lib Add body sample to the right panel 2015-10-25 13:26:38 +02:00
.gitignore Support for html and css in separate files 2015-10-03 12:50:35 +03:00
.travis.yml moved and minor fixed deployment script 2015-10-08 12:59:16 +03:00
gulpfile.js Initial configuration + build tasks 2015-10-03 12:38:41 +03:00
package.json Added marked markdown parser 2015-10-23 11:35:13 +03:00
README.md Added run instructions 2015-10-11 21:33:13 +03:00
system.config.js Added marked markdown parser 2015-10-23 11:35:13 +03:00

README.md

ReDoc prototype

Build Status

Prototype of component-based Swagger documentation

Under development

Live demo

Running locally

  1. Clone repository git clone https://github.com/RomanGotsiy/redoc-prototype.git
  2. Go to the project folder cd redoc-prototype
  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