diff --git a/.gitignore b/.gitignore index 9f11b75..0605c3d 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,3 @@ .idea/ +redoc-static.html +oengus-docs.json diff --git a/Dockerfile b/Dockerfile index fd40dc7..f22dfdf 100644 --- a/Dockerfile +++ b/Dockerfile @@ -5,11 +5,10 @@ WORKDIR /redoc RUN npm -g install redoc-cli COPY template.hbs ./ -RUN redoc-cli bundle https://oengus.io/api/v2/api-docs -t template.hbs +RUN redoc-cli build https://oengus.io/api/v3/api-docs -t template.hbs RUN ls -hal - # 2. serve html with nginx FROM alpine:latest WORKDIR /var/www/html diff --git a/README.md b/README.md index 69c7d16..5c9ebda 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,12 @@ # Oengus documentation Served at https://docs.oengus.io/ + +# Development + +```sh +# Either use this +npx @redocly/openapi-cli preview-docs http://localhost:8080/v3/api-docs -p 8000 +# Or do this instead and use your own http server +npm -g install redoc-cli +redoc-cli build http://localhost:8080/v3/api-docs -t template.hbs +``` diff --git a/template.hbs b/template.hbs index 5f65226..0aad461 100644 --- a/template.hbs +++ b/template.hbs @@ -8,8 +8,8 @@ {{{redocHead}}}