Skip to main content Skip to complementary content

Customizing the branding

Edit the portal to fit your branding.

Changing the portal title

Update the portal configuration to change its title.

About this task

By default, the title of the portal is "API Portal". You can customize this in the portal configuration file.

Procedure

  1. In your API Portal repository, open the config.toml file.
  2. Replace the default value of the title key with your new title.

    Example

    [languages.en]
      title = "My Developer Portal"
      weight = 1
  3. Commit your changes.

Results

Once your portal is deployed with this new configuration, the new title appears in the portal header and footer.

Changing the portal logo

Add your own logo to your portal.

Procedure

  1. In your API Portal repository, go to the /static/img folder.
  2. Replace the existing brand-logo.png with your own image.
    Make sure to keep the same filename.
  3. Commit your changes.

Results

Once your portal is deployed, the new logo appears in the top-left corner of the site.
Information noteNote: If you want to upload your logo with a different filename or format, you can add your new file to the /static/img folder and update the value of the --header-brand-logo variable in /assets/css/02_variables.css.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!