Skip to content
Esc
↑↓navigate↵open⌘Jpreview
On this page

Brand assets

Organize approved brand resources and register downloadable packages.

Keep approved files in your project and register shared downloads under brand.downloads. A download declaration describes an existing file; it does not create a ZIP or export artwork.

Prepare the files

Export approved artwork and prepare archives before linking them. Put public resources under public/brand/ so paths such as /brand/logo-pack.zip work.

Register shared downloads

Add the entries below to brand.downloads in brandtree.config.ts.

Present the downloads

Use a Brandtree download component on your guidelines pages. Check each link and update display metadata whenever you replace an archive.

File organization

public
brand
logotype-dark.svg
logotype-light.svg
mark-dark.svg
mark-light.svg
logo-pack.zip
brandtree.config.ts

Config asset paths

Config references distinguish public URLs from source files:

Form Resolves to
/brand/logo-pack.zip public/brand/logo-pack.zip under the client project
./assets/fonts/BrandSans.woff2 A source file relative to the client project root
file:///absolute/path/to/file An explicit filesystem path
https://example.com/file.zip, //example.com/file.zip, #section Not checked as a local file

Use /... public URLs for logo and download links. Local font sources normally use ./... paths; see Fonts. A source filesystem path is not a public browser URL. Bare paths such as assets/logo.svg are not accepted by the config asset checker.

Register downloads

This replaces brand.downloads; retain the rest of your config.

downloads: [{
  id: "logo-pack",
  label: "Logo pack",
  href: "/brand/logo-pack.zip",
  format: "ZIP",
  size: "2.4 MB",
  note: "Approved artwork in SVG and PDF.",
}],
PropType
idstring

Stable identifier, unique within downloads.

Typestring
labelstring

Visible download name.

Typestring
hrefstring

URL of the prepared file.

Typestring
format?string

Display label such as ZIP or PDF.

Typestring
size?string

Display size, maintained manually.

Typestring
note?string

Short explanation of the package contents.

Typestring

Check availability

Brandtree checks configured logo artwork, favicon, download links, local font sources, and enabled social-card logo overrides. A path must resolve to a readable regular file. Failures produce BRANDTREE_LOCAL_FILE_UNAVAILABLE warnings that identify the original config field; fix that reference or restore the file. Remote URLs are not fetched by this check.

Download links keep their authored href and use the browser’s download attribute. A missing archive still needs to be fixed: validation does not create it or silently remove the link. Browsers may open cross-origin files rather than download them, depending on the host’s response headers.

Was this page helpful?