Skip to main content

Examples

Each folder in examples/ is a tiny repo that brand-kit was run against. Everything below is real output.

Defaults​

npx @rtorcato/brand-kit in a repo with only a package.json. The tagline is the description; the accent falls back to grey.

basic banner

Custom tagline and accent​

npx @rtorcato/brand-kit --tagline "Brand assets you can regenerate" --accent "#e879f9"

custom banner

custom social card

Social images​

npx @rtorcato/brand-kit --social

X header

LinkedIn banner

See the social example for the avatar, Instagram post, story, YouTube and Facebook images.

A Docusaurus site​

In a repo with apps/docs, the accent and logo are read from the site's theme colour and favicon.

docusaurus banner