Support .redocly.yaml for options for redoc-cli

[adeschamps]

Hello,

When I preview docs with openapi preview-docs, it uses the theme defined in my .redocly.yaml file. Is there a way to render a static HTML file, much like redoc-cli bundle, that reads the theme from that file?

[ArtFlag]

Same question here. I'm currently switching between openapi and redoc-cli to validate/bundle/publish because I do not know where the HTML is after preview-docs.

It would we great to be able to output the bundled HTML to a given folder.

[rohit-gohri]

So the referenceDocs section in .redocly.yaml can be passed to redoc-cli bundle --options <stringified JSON|path to JSON>.

Using js-yaml I have this setup working:

A script file to convert yaml to json.

// preDocs.js
const yaml = require('js-yaml');
const fs = require('fs');

// Get document, or throw exception on error
try {
  const redocly = yaml.safeLoad(fs.readFileSync('.redocly.yaml', 'utf8'));
  const docsConfig = redocly.referenceDocs;
  fs.writeFileSync('.redoc.json', JSON.stringify(docsConfig, null, 2));
}
catch (e) {
  console.log(e);
}

# Bundle Docs
node preDocs.js && redoc-cli bundle api.v0.yaml --options .redoc.json

And add .redoc.json to .gitignore

Adding these to package.json makes it much easy:

"scripts": {
	"predocs": "node preDocs.js",
	"docs": "redoc-cli bundle api.v0.yaml --options .redoc.json",
	"docs:preview": "openapi preview-docs api.v0.yaml"
}

I can do npm run docs now to build and npm run docs:preview to preview.

[piotr-cz]

@rohit-gohri
This doesn't answer initial question, you still need the redoc-cli package to create static file and @redocly/openapi-cli to lint schema.

Both packages can serve preview.

[federinik]

Same issue here, is there any plan to support .redocly.yaml file as input for redoc-cli anytime soon?

[RomanHotsiy]

Yes. We plan to add support.