Skip to content

Commit 48e1761

Browse files
panzihleb-albau
authored andcommitted
redoc-cli requires absolute path to index.yml
`redoc-cli` requires an absolute path to `index.yml` for some reason. if you use `index.yml` or `./index.yml` it complains that `/index.yml` does not exist. Also fixed some formatting and a typo.
1 parent ae3a81e commit 48e1761

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,15 @@ docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli validate -
2626
```
2727

2828
## Building Redoc single page html documentation
29+
2930
Edit **rt.yml** - remove **components.schemas.ResultItem.discriminator** node
31+
3032
Edit **rt-authenticity.yml** - remove **components.schemas.AuthenticityCheckResultItem.discriminator**
31-
Than run next command:
33+
34+
Then run next command:
3235
```
33-
npx redoc-cli bundle index.yml --output document-reader-static-doc.html \
36+
npx redoc-cli bundle "$PWD/index.yml" --output document-reader-static-doc.html \
3437
--options.maxDisplayedEnumValues=5 --options.theme.logo.gutter="20px" \
3538
--options.theme.colors.primary.main="#8a53cb" --options.expandResponses="all" \
3639
--options.expandSingleSchemaField --options.hideDownloadButton --options.jsonSampleExpandLevel="6"
37-
```
40+
```

0 commit comments

Comments
 (0)