Document theme options in readme

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?

@imnotashrimp

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!

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?

@jjylha

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

@imnotashrimp

@imnotashrimp Any updates on this?

Following

PR for this opened here #1438

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

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

@RomanHotsiy

@RomanHotsiy , hello

Can be used on tag attributes?

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

Navigation Menu

Repository navigation

Document theme options in readme #523

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Document theme options in readme #523

Description

Activity

RomanHotsiy commented on Jun 1, 2018

jjylha commented on Jun 8, 2018

RomanHotsiy commented on Jun 18, 2018

ShaneGMamet commented on Nov 26, 2018

KimThibault commented on Jan 29, 2019

adeelibr commented on Aug 26, 2019

AlbertSuarez commented on Sep 17, 2019

sid22 commented on Oct 22, 2019

kscheirer commented on Oct 27, 2020

kscheirer commented on Jan 20, 2021

rbruggem commented on May 18, 2021

siarhei-kurhuzenkau-idf commented on Nov 5, 2021

lornajane commented on Nov 9, 2023

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions