Skip to content

Repository holding the implementation of the `_brand.yml` file based on Posit's `_brand.yml` spec.

Notifications You must be signed in to change notification settings

stanford-brand-yml/brand-yml

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 

Repository files navigation

Important

This is not an official Stanford University project. This is part of a demonstration for STATS 290 regarding branding for data science.

Stanford Brand YAML Configuration

This repository contains a _brand.yml configuration file that porivdes an unofficial implementation of Stanford University's identity guidelines. The configuration can be used across various data science applications and websites to maintain consistent Stanford branding.

Note

This configuration attempts to follow the official Stanford Identity Guide. Always refer to Stanford's brand guidelines for detailed usage instructions and best practices.

Overview

The _brand.yml file provides structured data for Stanford's:

  • Official color palette
  • Typography specifications
  • Logo usage parameters
  • Spacing and layout guidelines
  • Brand assets references

We can use this configuration file to switch to another brand theme easily. For example, we can use this configuration file to apply Stanford's brand to a Shiny Python app using the shiny Python package or to a Quarto document using the brand YAML key.

Usage

  1. Copy the _brand.yml file into your project's root directory
  2. Apply the _brand.yml:
    • Use brand_yml Python package to load the configuration into Python
    • Use ui.Theme.from_brand() to apply the configuration to a Shiny Python for Shiny app
    • Use brand YAML key in Quarto to apply the configuration to a Quarto document

Note

For logo images, please see Stanford Logos. Place the logo images in the assets directory next to the _brand.yml file.

File Structure

The _brand.yml contains the following main sections:

  • meta: Metadata about the brand configuration
  • color: Stanford's official color palette including Cardinal Red and secondary colors
  • typography: Font families, sizes, and weights for different content types
  • logo: Specifications for logo usage and minimum clear space
  • defaults: Default values for various design elements

Acknowledgements

About

Repository holding the implementation of the `_brand.yml` file based on Posit's `_brand.yml` spec.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published