Sign inSign up

testthedocs/redoc-cli

By testthedocs

Updated almost 4 years ago

Redoc CLI in a container - https://github.com/ocular-d/docker-redoc-cli

Image
0

10K+

testthedocs/redoc-cli repository overview

Docker Redoc CLI

Table of Contents

📄 About

Redoc CLI in a container.

🚀 Usage

docker run -it -v "$(pwd)"/spec:/app/spec testthedocs/redoc-cli --help
Commands:
  redoc-cli serve <spec>   start the server
  redoc-cli bundle <spec>  bundle spec into zero-dependency HTML-file

Options:
      --help             Show help                                     [boolean]
      --version          Show version number                           [boolean]
  -t, --template         Path to handlebars page template, see
                         https://git.io/vh8fP for the example           [string]
      --templateOptions  Additional options that you want pass to template. Use
                         dot notation, e.g. templateOptions.metaDescription
      --options          ReDoc options, use dot notation, e.g.
                         options.nativeScrollbars
Bundle OAS to HTML
docker run -it -v "$(pwd)"/spec:/app/spec testthedocs/redoc-cli bundle spec/openapi.json -o spec/pet-store.html

🤝 Contributing

We are a community effort, and everybody is most welcome to participate!

Be it filing bugs, formulating enhancements, creating pull requests, or any other means of contribution, we encourage contributions from everyone.

📝 License

Distributed under the MIT license.

Tag summary

Content type

Image

Digest

sha256:4e34fb355

Size

66 MB

Last updated

almost 4 years ago

docker pull testthedocs/redoc-cli