From 3e4a712912f03191c0fb5b8b86abf310592b99ae Mon Sep 17 00:00:00 2001 From: anastasiia-developer Date: Tue, 10 May 2022 12:05:17 +0300 Subject: [PATCH] docs: instructions for using .redocly.yaml --- cli/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/cli/README.md b/cli/README.md index 1d6537b6..29002ce1 100644 --- a/cli/README.md +++ b/cli/README.md @@ -31,4 +31,10 @@ Some examples: - Bundle using a custom template and add custom `templateOptions`:
`$ 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`.