Configuration
EventCatalog allows you to define overrides for your organization. These exist in the eventcatalog.config.js file.
Catalog configuration
The eventcatalog.config.js file is the heart of your application. It allows you to define overrides for EventCatalog.
See the API documentation to override defaults for EventCatalog.
Setting up VSCode
EventCatalog uses MDX file format for documentation.
If you are using VSCode you can install the MDX plugin, for the .mdx files.
Recommended Plugins:
- https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx
- https://marketplace.visualstudio.com/items?itemName=astro-build.astro-vscode
Customize favicon
You can customize the favicon for your EventCatalog by adding a favicon in in the public directory: /public/favicon.ico.
Configuring environment variables
eventcatalog@2.35.4EventCatalog can use environment variables to configure the site, depending on what features you are using (e.g plugins or plans).
If you are using EventCatalog Plugins, or any EventCatalog Plans you can put these into your .env file.
EVENTCATALOG_SCALE_LICENSE_KEY=your-api-key
EventCatalog community edition is free to use and does not require a license key.
Some features of EventCatalog require a license key, these include:
You can get a 14 day free trial of any of the plans here.
Once you get the license key you can put it in your .env file.
Setting up GitHub Action
If you want to use the EventCatalog GitHub Action, you can read the documentation here.