File tree Expand file tree Collapse file tree 1 file changed +6
-5
lines changed Expand file tree Collapse file tree 1 file changed +6
-5
lines changed Original file line number Diff line number Diff line change 1111</center >
1212
1313## Why?
14- There are a few advantages in hosting your API specification + docs on GitHub:
14+ There are a few advantages in hosting your API definition + docs on GitHub:
1515 - Community engagement (PR's and issues)
1616 - Hosting on GitHub pages (perfect uptime, CDN, Jekyll, custom domains with CNAME)
1717 - Advertisment in the GitHub community
1818 - Revision history, branching, CI
19- - Fast on-boarding time (everyone knows how to use GitHub :smile : )
19+ - Fast on-boarding time (developers and tech writers know how to use GitHub :smile : )
20+ - Fully compatible with Redocly API Reference too
2021
2122## Features
2223This generator helps to create a GitHub repo with the following features:
23- - Possibility to split a big OpenAPI spec into smaller files and bundle it for deployment
24+ - Possibility to split a big OpenAPI definition into smaller files and bundle it for deployment
2425 - Continuous integration/deployment on Travis
2526 - Code samples as separate files
26- - OpenAPI spec is validated after each commit
27- - OpenAPI spec + ReDoc deployed to Github Pages (you can use a custom domain)
27+ - OpenAPI definition is validated after each commit
28+ - OpenAPI definition + ReDoc deployed to Github Pages (you can use a custom domain)
2829 - Live editing in your editor or ` swagger-editor ` :heart_eyes :
2930 ![ live editing] ( ./live-edit.gif )
3031
You can’t perform that action at this time.
0 commit comments