All paths in logo are now promoted to BrandLogoResource instances. This adds a bit of overhead but makes the Brand instance consistent, where consumers can always look in *.path for the path to a resource which will have an adjacent, optional, .alt property.
This also means that logo: <string> values are promoted to BrandLogoResources, so consumers can expect logo to be either a full BrandLogo or a simple BrandLogoResource:
# Can be written like this
logo: brand-yaml.png
# Parsed into the equivalent of this (alt would be missing)
logo:
path: brand-yaml.png
alt: The Brand YAML logo
The examples/brand-logo-full-alt.yml file gives a complete example with all options
logo:
images:
mark:
path: logos/pandas/pandas_mark.svg
alt: pandas logo with blue bars and yellow and pink dots
mark-white: logos/pandas/pandas_mark_white.svg
secondary: logos/pandas/pandas_secondary.svg
secondary-white:
path: logos/pandas/pandas_secondary_white.svg
alt: pandas logo with bars and dots over the word "pandas"
pandas: logos/pandas/pandas.svg
pandas-white: logos/pandas/pandas_white.svg
small: mark
medium:
light:
path: logos/pandas/pandas_secondary.svg
alt: pandas logo with bars and dots over the word "pandas"
dark: secondary-white
large:
path: logos/pandas/pandas.svg
alt: pandas bars and dots to the right of the word "pandas"
For #19
All paths in
logo
are now promoted toBrandLogoResource
instances. This adds a bit of overhead but makes theBrand
instance consistent, where consumers can always look in*.path
for the path to a resource which will have an adjacent, optional,.alt
property.This also means that
logo: <string>
values are promoted toBrandLogoResource
s, so consumers can expectlogo
to be either a fullBrandLogo
or a simpleBrandLogoResource
:The
examples/brand-logo-full-alt.yml
file gives a complete example with all options