Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2025-08-07 21:54:53 +03:00
Code Issues Packages Projects Releases Wiki Activity

remove #CE comments

Browse Source 
removed #CE from comments, since this readme is only used for the community edition
This commit is contained in:
Karl Scheirer 2020-11-19 11:42:56 -08:00 committed by GitHub
parent 9e0c10128d
commit 97863d9b50
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 43 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

88
README.md
View File

@ -255,63 +255,61 @@ You can use all of the following options with standalone version on <redoc> tag
* `untrustedSpec` - if set, the spec is considered untrusted and all HTML/markdown is sanitized to prevent XSS. **Disabled by default** for performance reasons. **Enable this option if you work with untrusted user data!** * `untrustedSpec` - if set, the spec is considered untrusted and all HTML/markdown is sanitized to prevent XSS. **Disabled by default** for performance reasons. **Enable this option if you work with untrusted user data!**
### `<redoc>` theme object ### `<redoc>` theme object
Theme options below designated with `#CE` are supported by Redoc Community Edition (CE).
* `spacing` * `spacing`
* `unit`: 5 # CE # main spacing unit used in autocomputed theme values later * `unit`: 5 # main spacing unit used in autocomputed theme values later
* `sectionHorizontal`: 40 # CE # Horizontal section padding. COMPUTED: spacing.unit * 8 * `sectionHorizontal`: 40 # Horizontal section padding. COMPUTED: spacing.unit * 8
* `sectionVertical`: 40 # CE # Horizontal section padding. COMPUTED: spacing.unit * 8 * `sectionVertical`: 40 # Horizontal section padding. COMPUTED: spacing.unit * 8
* `breakpoints` # CE # breakpoints for switching three/two and mobile view layouts * `breakpoints` # breakpoints for switching three/two and mobile view layouts
* `small`: '50rem' * `small`: '50rem'
* `medium`: '85rem' * `medium`: '85rem'
* `large`: '105rem' * `large`: '105rem'
* `colors` * `colors`
* `tonalOffset`: 0.3 # CE # default tonal offset used in computations * `tonalOffset`: 0.3 # default tonal offset used in computations
* `typography` * `typography`
* `fontSize`: '14px' # CE * `fontSize`: '14px'
* `lineHeight`: '1.5em' # CE * `lineHeight`: '1.5em'
* `fontWeightRegular`: '400' # CE * `fontWeightRegular`: '400'
* `fontWeightBold`: '600' # CE * `fontWeightBold`: '600'
* `fontWeightLight`: '300' # CE * `fontWeightLight`: '300'
* `fontFamily`: 'Roboto, sans-serif' # CE * `fontFamily`: 'Roboto, sans-serif'
* `smoothing`: 'antialiased' # CE * `smoothing`: 'antialiased'
* `optimizeSpeed`: true # CE * `optimizeSpeed`: true
* `headings` * `headings`
* `fontFamily`: 'Montserrat, sans-serif' # CE * `fontFamily`: 'Montserrat, sans-serif'
* `fontWeight`: '400' # CE * `fontWeight`: '400'
* `lineHeight`: '1.6em' # CE * `lineHeight`: '1.6em'
* `code` # inline code styling * `code` # inline code styling
* `fontSize`: '13px' # CE * `fontSize`: '13px'
* `fontFamily`: 'Courier, monospace' # CE * `fontFamily`: 'Courier, monospace'
* `lineHeight`: # COMPUTED: typography.lineHeight # CE * `lineHeight`: # COMPUTED: typography.lineHeight
* `fontWeight`: # COMPUTED: typography.fontWeightRegular # CE * `fontWeight`: # COMPUTED: typography.fontWeightRegular
* `color`: '#e53935' # CE * `color`: '#e53935'
* `backgroundColor`: 'rgba(38, 50, 56, 0.05)' # CE * `backgroundColor`: 'rgba(38, 50, 56, 0.05)'
* `wrap`: false # whether to break word for inline blocks (otherwise they can overflow) # CE * `wrap`: false # whether to break word for inline blocks (otherwise they can overflow)
* `links` * `links`
* `color`: # COMPUTED: colors.primary.main # CE * `color`: # COMPUTED: colors.primary.main
* `visited`: # COMPUTED: typography.links.color # CE * `visited`: # COMPUTED: typography.links.color
* `hover`: # COMPUTED: lighten(0.2 typography.links.color) # CE * `hover`: # COMPUTED: lighten(0.2 typography.links.color)
* `menu` * `menu`
* `width`: '260px' # CE * `width`: '260px'
* `backgroundColor`: '#fafafa' # CE * `backgroundColor`: '#fafafa'
* `textColor`: '#333333' # CE * `textColor`: '#333333'
* `activeTextColor`: # COMPUTED: theme.menu.textColor (if set by user) or theme.colors.primary.main # CE * `activeTextColor`: # COMPUTED: theme.menu.textColor (if set by user) or theme.colors.primary.main
* `groupItems` # Group headings # CE * `groupItems` # Group headings
* `textTransform`: 'uppercase' # CE * `textTransform`: 'uppercase'
* `level1Items` # Level 1 items like tags or section 1st level items # CE * `level1Items` # Level 1 items like tags or section 1st level items
* `textTransform`: 'none' # CE * `textTransform`: 'none'
* `arrow` # menu arrow # CE * `arrow` # menu arrow
* `size`: '1.5em' # CE * `size`: '1.5em'
* `color`: # COMPUTED: theme.menu.textColor # CE * `color`: # COMPUTED: theme.menu.textColor
* `logo` * `logo`
* `maxHeight`: # COMPUTED: menu.width # CE * `maxHeight`: # COMPUTED: menu.width
* `maxWidth`: # COMPUTED: menu.width # CE * `maxWidth`: # COMPUTED: menu.width
* `gutter`: '2px' # logo image padding # CE * `gutter`: '2px' # logo image padding
* `rightPanel` * `rightPanel`
* `backgroundColor`: '#263238' # CE * `backgroundColor`: '#263238'
* `width`: '40%' # CE * `width`: '40%'
* `textColor`: '#ffffff' # CE * `textColor`: '#ffffff'
## Advanced usage of standalone version ## Advanced usage of standalone version
Instead of adding `spec-url` attribute to the `<redoc>` element you can initialize ReDoc via globally exposed `Redoc` object: Instead of adding `spec-url` attribute to the `<redoc>` element you can initialize ReDoc via globally exposed `Redoc` object: