Skip to main content
Every ecge project requires an ecge.config.json file in the root directory. This file defines your project’s core settings.

Properties

string
required
The name of your project. Used as the global title and in metadata.Example: "my-app"
Navigation[]
required
An array of groups defining the pages in your sidebar navigation.
Path to a logo image, or an object with separate light and dark mode logos.
string
Path to the favicon image.
Colors
Hex color codes for your project’s theme.
Links displayed in the top navigation bar.
Call to Action
A call-to-action button in the top bar.
string[]
Version names for a version selector dropdown in the navigation bar.
API
Configuration for API playground settings.
string | string[]
URL(s) or relative path(s) to your OpenAPI specification file(s).Examples:
Social media links displayed in the footer.Example:
ModeToggle
Dark mode toggle configuration.