https://github.com/posit-dev/brand-yml
Unified branding with a single yaml file.
https://github.com/posit-dev/brand-yml
Last synced: 11 days ago
JSON representation
Unified branding with a single yaml file.
- Host: GitHub
- URL: https://github.com/posit-dev/brand-yml
- Owner: posit-dev
- License: mit
- Created: 2024-03-20T19:24:12.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-04T21:53:41.000Z (about 1 month ago)
- Last Synced: 2025-04-02T01:17:15.661Z (14 days ago)
- Language: Python
- Homepage: https://posit-dev.github.io/brand-yml/
- Size: 12.9 MB
- Stars: 55
- Watchers: 4
- Forks: 6
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- jimsghstars - posit-dev/brand-yml - Unified branding with a single yaml file. (Python)
README
Unified branding with a single YAML file
## About brand.yml
Create reports, apps, dashboards, plots and more that match your company's brand guidelines with a single `_brand.yml` file.
**brand.yml** is a simple, portable YAML file that codifies your company's brand guidelines into a format that can be used by [Quarto](https://quarto.org), Python and R tooling to create branded outputs.
Our goal is to support unified, branded theming for all of [Posit's open source tools](https://posit.co/products/open-source/)—from web applications to printed reports to dashboards and presentations—with a consistent look and feel.
With a single `_brand.yml` file you can collect brand logos, colors, fonts and typographic choices, typically found in your company's brand guidelines.
This `_brand.yml` can be used Quarto and Shiny for Python[^1] to instantly basic themes that match the brand guidelines.
## Links
- [brand.yml Documentation](https://posit-dev.github.io/brand-yml) - The brand.yml specification, explanation, details, examples and more.
- [brand_yml for Python](https://posit-dev.github.io/brand-yml/pkg/py) - Python package for reading and applying the `_brand.yml` file.
- [Quarto](https://quarto.org) - An open-source scientific and technical publishing system. Automatically uses `_brand.yml` in the v1.6 release.
- [Shiny](https://shiny.posit.co) - An open-source framework for effortless web applications for data scientists. [Shiny for Python](https://shiny.posit.co/py) supports [branded theming via brand.yml](https://shiny.posit.co/py/api/core/ui.Theme.html#shiny.ui.Theme.from_brand). Support in Shiny for R will arrive soon.
## Contributing
**Questions?** Feel free to ask questions in [our discussions forum](https://github.com/posit-dev/brand-yml/discussions)! For questions about using brand.yml in Quarto, please head over to [Quarto's discussions](https://github.com/quarto-dev/quarto-cli/discussions).
We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) before opening a pull request.