Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2025-08-06 05:10:20 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: instructions for using .redocly.yaml

Browse Source
This commit is contained in:
anastasiia-developer 2022-05-10 12:05:17 +03:00
parent 74c9e81f8d
commit 3e4a712912
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
cli/README.md
View File

@ -31,4 +31,10 @@ Some examples:
- Bundle using a custom template and add custom `templateOptions`:<br/> - Bundle using a custom template and add custom `templateOptions`:<br/>
`$ redoc-cli build [spec] -t custom.hbs --templateOptions.metaDescription "Page meta description"` `$ redoc-cli build [spec] -t custom.hbs --templateOptions.metaDescription "Page meta description"`
#### With `.redocly.yaml` file ([more info](https://redoc.ly/docs/api-reference-docs/on-premise/cli-usage/#example-with-try-it-console-enabled)):
1. Go to folder with `.redocly.yaml` and your definition file
2. Build site using command (options from `.redocly.yaml` file will be automatically fetched):
`redoc build openapi.yaml`
For more details, run `redoc-cli --help`. For more details, run `redoc-cli --help`.