Every ecge project requires an ecge.config.json file in the root directory. This file defines your project’s core settings.
Properties
The name of your project. Used as the global title and in metadata.Example: "my-app"
An array of groups defining the pages in your sidebar navigation.
The display name of the group.Example: "Getting Started"
Relative paths to the MDX files that serve as pages.Example: ["quickstart", "configuration"]
Path to a logo image, or an object with separate light and dark mode logos.
Path to the logo displayed in light mode.
Path to the logo displayed in dark mode.
URL the logo links to when clicked.
Path to the favicon image.
Hex color codes for your project’s theme.
The primary accent color used for highlights, links, and interactive elements.
The accent color used in dark mode.
The color used for primary buttons and CTAs.
Background colors for light and dark mode.
Background color in light mode.
Background color in dark mode.
Links displayed in the top navigation bar.
The link label.Example: "Contact us"
A call-to-action button in the top bar.
type
"link" or "github"
default:"link"
Display style. "github" shows repository star count.
The button’s destination URL.
Button label text. Required when type is "link".
Version names for a version selector dropdown in the navigation bar.
Configuration for API playground settings.
The base URL for all API endpoints. Pass an array to enable multiple base URL options.
method
"bearer" | "basic" | "key"
Authentication strategy for API endpoints.
Name of the authentication parameter.
URL(s) or relative path(s) to your OpenAPI specification file(s).Examples:"openapi": "https://api.ecge.dev/openapi.json"
Social media links displayed in the footer.Example:{
"github": "https://github.com/ecge",
"x": "https://x.com/ecge"
}
Dark mode toggle configuration.
Default color mode for new visitors. Defaults to the user’s OS preference.
Set to true to hide the toggle and lock to the default mode."modeToggle": {
"default": "dark",
"isHidden": true
}
