Metadata

About

The meta section in a _brand.yml provides a place to store metadata about the company or project described in the file. This information may be used by tools that support brand.yml to add social media icons, links, footers, etc. It can also be used as a place to store additional context about the company or brand that you’d like to store in a common place.

Structure

The meta section primarily consists of two main components:

  1. name: The name of the company or brand
  2. link: URLs to the brand’s online presence

Both name and link are optional fields, and you can add additional fields as needed for your specific use case.

Examples

Here are some examples of how you might use the meta section in your brand.yml file:

Minimal Example

_brand.yml
meta:
  name: Acme Corporation
  link: https://www.acmecorp.com

Comprehensive Example

_brand.yml
meta:
  name:
    full: Acme Corporation International
    short: Acme
  link:
    home: https://www.acmecorp.com
    docs: https://docs.acmecorp.com
    github: https://github.com/acmecorp
    bluesky: https://bsky.app/profile/acmecorp.bsky.social
    twitter: https://twitter.com/acmecorp
    linkedin: https://www.linkedin.com/company/acmecorp
    facebook: https://www.facebook.com/acmecorp
  description: |
    Acme Corporation is a leading provider of innovative solutions for cartoon
    characters worldwide.
  founded: 1952

Attributes

Name

The name field can be specified in two ways:

  1. As a simple string, representing the full name of the company or brand:

    _brand.yml
    meta:
  name: Acme Corporation

  2. As an object with full and short properties:

    _brand.yml
    meta:
  name:
    full: Acme Corporation International
    short: Acme

    This format is useful when you need to distinguish between a full company name and a shorter version depending on context.