Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2025-07-23 14:40:00 +03:00
Code Issues Packages Projects Releases Wiki Activity

chore: improve deprecation message for serve command (#2096)

Browse Source
This commit is contained in:
Alex Varchuk 2022-07-25 19:10:31 +03:00 committed by GitHub
parent 17bb08909a
commit e4f84bb7de
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cli/README.md
View File

@ -14,7 +14,7 @@ The two following commands are available:
- `redoc-cli serve [spec]` - starts the server with `spec` rendered with ReDoc. - `redoc-cli serve [spec]` - starts the server with `spec` rendered with ReDoc.
Supports a server-side rendering mode (`--ssr`) Supports a server-side rendering mode (`--ssr`)
and can watch the spec (`--watch`) to automatically reload the page whenever it changes.\ and can watch the spec (`--watch`) to automatically reload the page whenever it changes.\
Deprecated. Use `npx @redocly/openapi-cli preview-docs [spec]` Deprecated. Use `npx @redocly/cli preview-docs [spec]`
- `redoc-cli bundle [spec]` - bundles `spec` and Redoc into a **zero-dependency** HTML file.\ - `redoc-cli bundle [spec]` - bundles `spec` and Redoc into a **zero-dependency** HTML file.\
Deprecated. Use Use "build" command instead. Deprecated. Use Use "build" command instead.
- `redoc-cli build [spec]` - build `spec` and Redoc into a **zero-dependency** HTML file. - `redoc-cli build [spec]` - build `spec` and Redoc into a **zero-dependency** HTML file.

2
cli/index.ts
View File

@ -182,7 +182,7 @@ YargsParser.command(
[ [
res => { res => {
console.log( console.log(
`\n⚠️ This command is deprecated. Use "npx @redocly/openapi-cli preview-docs petstore.yaml"\n`, `\n⚠️ This command is deprecated. Use "npx @redocly/cli preview-docs petstore.yaml"\n`,
); );
return res; return res;
}, },