Skip to content

Commit

Permalink
More minor updates
Browse files Browse the repository at this point in the history
  • Loading branch information
RomanHotsiy committed Aug 29, 2016
1 parent 5cf92e4 commit 21329ea
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 4 deletions.
2 changes: 2 additions & 0 deletions README.md
Expand Up @@ -16,6 +16,8 @@ This generator helps to create a GitHub repo with the following features:
- Code samples as separate files
- Swagger spec is validated after each commit
- Swagger spec + ReDoc deployed to Github Pages (you can use a custom domain)
- Live editing in your editor or `swagger-editor` :heart_eyes:
![live editing](./live-edit.gif)

## Installation

Expand Down
2 changes: 1 addition & 1 deletion generators/app/index.js
Expand Up @@ -230,7 +230,7 @@ module.exports = yeoman.Base.extend({
bower: false,
callback: () => {
this.log(chalk.green(
'✨Congratulation!✨\n' +
'✨ Congratulation!✨\n' +
'Your OpenAPI repo has been generated.\n' +
'Check out README.md for the further steps'
))
Expand Down
1 change: 1 addition & 0 deletions generators/app/templates/_README.md
Expand Up @@ -39,5 +39,6 @@
2. Checkout console output to see where local server is started. You can use all [links](#links) (except `preview`) by replacing <%= ghPagesBaseUrl %> with url from the message: `Server started <url>`
3. Make changes using your favorite editor or `swagger-editor` (look for URL in console output)
4. All changes are immediately propagated to your local server, moreover all documentation pages will be automagically refreshed in a browser after each change
**TIP:** you can open `swagger-editor`, documentation and `swagger-ui` in parallel
5. Once you finish with the changes you can run tests using: `npm test`
6. Share you changes with the rest of the world by commiting :smile:
5 changes: 2 additions & 3 deletions generators/app/templates/_spec/README.md
@@ -1,8 +1,7 @@
## Global headers

In order to minimaze duplications you can use `headers` global object (similar to `definitions`, `responses`).
Durinb build process all references to global `headers` will be inlined and `headers` will be removed form resulting spec
so spec will be valid (global `headers` is not allowed by Swagger spec):
In order to minimize duplications you can use `headers` global object (similar to `definitions`, `responses`).
During build process all references to global `headers` will be inlined and `headers` will be removed form resulting spec so spec will be valid (global `headers` is not allowed by Swagger spec):

Example:
```yaml
Expand Down
Binary file added live-edit.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 21329ea

Please sign in to comment.