Contributing
The logos, banners, tokens and social templates are made in the brand repository. Everything in its assets/ and tokens/ is generated. Change the scripts, run the build, and commit what comes out. Hand-edit a PNG and the next build will quietly undo your work, which is the most passive-aggressive code review there is.
Building
Section titled “Building”You need Node 24 (there’s an .nvmrc). From the repository root:
npm cinpm run buildThe build wipes assets/ and tokens/ and makes them again. It takes a few seconds. CI runs the same build and fails if anything changed, so a pull request with stale files won’t pass.
Where things live
Section titled “Where things live”| File | What it holds |
|---|---|
scripts/brand.mjs |
The organisation, every template, every colour scale. Start here. |
scripts/geometry.mjs |
The rings: radii, gaps and where each ring is cut. |
scripts/colours.mjs |
Which shade goes on which ring, and the spectrum arrangement. |
scripts/logo.mjs |
Turns geometry and colours into an SVG, with or without a frame. |
scripts/social.mjs |
The social template layout. |
scripts/text.mjs |
Turns text into outlines with the bundled fonts, so SVGs look the same everywhere. |
scripts/tokens.mjs |
Writes the token files and Starlight themes. |
scripts/build.mjs |
Decides which files to make, at which sizes. |
fonts/ |
The three typefaces, under the SIL Open Font Licence. |
Adding a template
Section titled “Adding a template”- Add it to
templatesinscripts/brand.mjs, with a hue nobody else is using. If it’s one of the reserved ones, fill in therepo,packageandwhatfields and dropreserved: true. - Run
npm run build. You get its logos, web icons, social preview and Starlight accent. - Add a section for it on Logo files and a row on Quick downloads. These pages live in the website repository, in
src/content/docs/brand/.
A brand new hue needs a full 50 to 900 scale in scales. Check it against the others on the Templates page before you commit to it: two neighbours that look alike in a row of marks are the thing to avoid.
These pages
Section titled “These pages”The pages you’re reading live with the rest of the docs in the website repository, so the brand gets the same header, footer and search as the templates. The website checks out the newest release of the brand repository every time it builds and copies in what it needs, so nothing here is a hand-made copy.
Releasing
Section titled “Releasing”Merging into the brand repository’s main updates the files READMEs and NuGet pages link to straight away. These pages only move when there’s a release. Run the brand repository’s Release workflow and it tags main with the date and attaches the whole kit as a zip. The website builds every morning, so the release shows up here by the next day. In a hurry? Run the website’s Site workflow by hand.