# Configure Redoc CE

Redoc CE comes with many configuration options to help you customize your API documentation.

Each deployment type has documentation on how to configure options for that type of Redoc CE project.
This page lists all the options you can use with Redoc CE.

**Versions: 3.x**

Redoc CE 3.x supports the following configuration options:

- [downloadUrls](/docs/realm/config/openapi/download-urls)
- [generatedSamplesMaxDepth](/docs/realm/config/openapi/generated-samples-max-depth)
- [hideDownloadButtons](/docs/realm/config/openapi/hide-download-buttons)
- [hidePropertiesPrefix](/docs/realm/config/openapi/hide-properties-prefix)
- [hideSchemaTitles](/docs/realm/config/openapi/hide-schema-titles)
- [jsonSamplesExpandLevel](/docs/realm/config/openapi/json-samples-expand-level)
- [layout](/docs/realm/config/openapi/layout)
- [maxDisplayedEnumValues](/docs/realm/config/openapi/max-displayed-enum-values)
- [onlyRequiredInSamples](/docs/realm/config/openapi/only-required-in-samples)
- [sanitize](/docs/realm/config/openapi/sanitize)
- [schemaDefinitionsTagName](/docs/realm/config/openapi/schema-definitions-tag-name)
- [schemasExpansionLevel](/docs/realm/config/openapi/schemas-expansion-level)
- [showExtensions](/docs/realm/config/openapi/show-extensions)
- [sortRequiredPropsFirst](/docs/realm/config/openapi/sort-required-props-first)


Additionally, the following options are available from the previous versions of Redoc CE:

| Option | Type | Description |
|  --- | --- | --- |
| skipBundle | boolean | When `true`, skips the bundle step when building API docs.
Use when the description files are provided directly and do not require re-bundling.
Default: `false`. |
| ignoreNamedSchemas | [string] | Provide a list of schema names to ignore when building docs.
Default: `['java.io.ObjectStreamField'],`. |
| scrollYOffset | string | Specifies a vertical scroll-offset in pixels.
Use when your docs have fixed positioned elements at the top of the page, such as navbars, headers, etc.
Default: `0`. |
| hideLoading | boolean | When `true`, hides the loading animation.
Does not apply to CLI-rendered docs.
Default: `false`. |
| hideSidebar | boolean | When `true`, hides the left sidebar.
Default: `false`. |


Example:


```yaml
downloadUrls:
  - title: Download OpenApiDescription
    url: 'https://example.com/museum.yaml'
  - title: Download OpenApiDescription json
    url: 'https://example.com/museum.json'
schemaDefinitionsTagName: Schemas
hideSidebar: true
jsonSamplesExpandLevel: 1
generatedSamplesMaxDepth: 3
hideDownloadButtons: false
hideLoading: true
hideSchemaTitles: false
maxDisplayedEnumValues: 3
onlyRequiredInSamples: true
schemasExpansionLevel: 3
sortRequiredPropsFirst: true
showExtensions: true
sanitize: true
skipBundle: false
ignoreNamedSchemas: ['java.io.ObjectStreamField']
layout: three-panel
scrollYOffset: 100
hidePropertiesPrefix: false
```

## Resources

- **[Redoc CE deployment guide](/docs/redoc/v3.x/deployment/intro)** - Learn about the different ways you can deploy API documentation with Redoc CE
- **[Use the Redoc CE Docker image](/docs/redoc/v3.x/deployment/docker)** - Deploy API documentation with Docker
- **[Use Redoc CE in HTML](/docs/redoc/v3.x/deployment/html)** - Deploy API documentation embedded in an HTML page
- **[Use Redoc CE React component](/docs/redoc/v3.x/deployment/react)** - Deploy API documentation in a React page
- **[Migration from Redoc CE 2.x to 3.x](/docs/redoc/v3.x/config-migration)** - Migrate Redoc CE configuration to version 3.x
- **[Telemetry](/docs/redoc/v3.x/telemetry)** - Learn about the telemetry used in Redoc CE