Metadata

BrandMeta

BrandMeta()

Brand Metadata

Brand metadata is stored in meta, providing place to describe the company or project, the brand guidelines, additional links, and more.

Attributes

name

BrandMetaName | None

The name of the brand. In the YAML, this may be a dictionary with the full and short forms of the brand name.

meta:
  name:
    full: Very Big Corporation of America
    short: VBCA

or a single value as shorthand for meta.name.full.

meta:
  name: Very Big Corporation of America
link

BrandMetaLink | None

Links to additional resources related to the brand, such as its homepage, social media accounts, etc. Like name, this can be a single value or a dictionary with additional keys. If a single value is provided, it is promoted to the home key of brand_yml.meta.BrandMetaLink.

These two constructions are equivalent:

meta:
  link: https://www.very-big-corp.com/
meta:
  link:
    home: https://www.very-big-corp.com/

Notes

Additional fields are allowed, so you may store any additional metadata you want to attach to the brand here. Tools that use brand_yml may not know about these fields, however.

Examples

_brand.yml
meta:
  name: Very Big Corp. of America
  link: https://very-big-corp.com
_brand.yml
meta:
  name:
    full: Very Big Corporation of America
    short: VBC
  link:
    home: https://very-big-corp.com
    mastodon: https://mastodon.social/@VeryBigCorpOfficial
    github: https://github.com/Very-Big-Corp
    linkedin: https://linkedin.com/company/very-big-corp
    twitter: https://twitter.com/VeryBigCorp
    facebook: https://facebook.com/Very-Big-Corp

meta.BrandMetaName

meta.BrandMetaName()

Attributes

Name Description
full Full name of the company or brand.
short Short name of the company or brand, for use in space-constrained settings.