Logo

Warning

This section still reflects the brand.yml spec during design. It will be updated shortly to reflect the current brand.yml specification.

About

Provide a logo and an icon for the company.

Brand guidelines may include many logo files; not all will be used for small, medium or large. The with field (may be aliased as files) can be used to provide a list of logo files with convenient names that may be re-used in the logo field.

Example

brand.yml (simple)

logo: posit.png

brand.yml (full)

logo:
  small: posit-icon.png
  medium: posit.png
  large: posit.svg

brand.yml (light/dark)

logo:
  small: posit-icon.png
  medium:
    light: posit.png
    dark: posit-reverse.png
  large: posit.svg

brand.yml (with files)

logo:
  with:
    primary: posit-full-color.png
    primary-svg: posit-full-color.svg
    reverse: posit-full-color-reverse.png
    black: posit-black.png
    white: posit-white.png
    icon: posit-favicon.png
  small: icon
  medium: primary
  large: primrary-svg

Spec

- id: brand-logo
  description: >
    Provide definitions and defaults for brand's logo in various formats and sizes.
  anyOf:
    - string
    - object:
        closed: true
        properties:
          with:
            schema:
              object:
                additionalProperties:
                  schema:
                    ref: brand-string-light-dark
          small:
            description: >
              A link or path to the brand's small-sized logo or icon, or a link or path
              to both the light and dark versions.
            schema:
              ref: brand-string-light-dark
          medium:
            description: >
              A link or path to the brand's medium-sized logo, or a link or path
              to both the light and dark versions.
            schema:
              ref: brand-string-light-dark
          large:
            description: >
              A link or path to the brand's large- or full-sized logo, or a link or path
              to both the light and dark versions.
            schema:
              ref: brand-string-light-dark