Document theme options in readme

[imnotashrimp]

I'd like to volunteer to write usage of the theme options.

Any chance you can give me some guidance on how to use it so I can get started?

[RomanHotsiy]

@imnotashrimp awesome! Thanks!

The preferred way to use a theme is to pass it in the options of Redoc.init call: https://github.com/Rebilly/ReDoc#advanced-usage-of-standalone-version:

Redoc.init('http://petstore.swagger.io/v2/swagger.json', {
  theme: {
    main: '#ff0000'
  }
}, document.getElementById('redoc-container'))

See the default theme for details: https://github.com/Rebilly/ReDoc/blob/master/src/theme.ts#L3

note you can use functions in the theme e.g.:

https://github.com/Rebilly/ReDoc/blob/63ae2e8e943b1cf2838db20c6c567156a2bfac45/src/theme.ts#L35

Theme can't be used on <redoc> tag attributes yet.

Feel free to ask additional question!

[jjylha]

So did I understand correctly that you can not theme ReDoc by using <redoc theme=""> at all the moment?

You have to use React component or Redoc.init to actually be able to theme anything?

[RomanHotsiy]

@jjylha, yes, you've got it correctly.

[ShaneGMamet]

@imnotashrimp Any updates on this?

[KimThibault]

Following

[adeelibr]

Following

[AlbertSuarez]

Following

[sid22]

Following

[kscheirer]

PR for this opened here #1438

[kscheirer]

PR was merged, I think this ticket can be closed.

[rbruggem]

I am a bit confused.
From https://github.com/Redocly/redoc#tldr, how do I apply https://github.com/Redocly/redoc#redoc-theme-object ?

[siarhei-kurhuzenkau-idf]

@RomanHotsiy , hello

Can be used on tag attributes?

[lornajane]

Documentation for the configuration, including theme options, has been updated. Find it here: https://redocly.com/docs/redoc/config/