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 11
11
</center >
12
12
13
13
## 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:
15
15
- Community engagement (PR's and issues)
16
16
- Hosting on GitHub pages (perfect uptime, CDN, Jekyll, custom domains with CNAME)
17
17
- Advertisment in the GitHub community
18
18
- 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
20
21
21
22
## Features
22
23
This 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
24
25
- Continuous integration/deployment on Travis
25
26
- 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)
28
29
- Live editing in your editor or ` swagger-editor ` :heart_eyes :
29
30
![ live editing] ( ./live-edit.gif )
30
31
You can’t perform that action at this time.
0 commit comments