css

Primer CSS is the CSS implementation of GitHub's Primer Design System, published on npm as `@primer/css`. It supplies the styling layer of Primer: utility classes and component styles that teams can reuse to keep interfaces visually consistent. What it contains - Sass source written in SCSS syntax, importable as a whole or by module. - Distinct entry points for different contexts: `core`, `product` and `marketing`, so a project can pull in only the styling it needs. - A documented theme and component set, described on the project's documentation site at primer.style/css, which covers getting started, components, theming and design principles. Installation and usage After installing npm, the package can be added to a project with `npm install --save @primer/css`. Because the sources are SCSS, the project's `node_modules` directory needs to be on the Sass include (load) paths. From there, the full stylesheet can be imported with `@import "@primer/css/index.scss";`, or individual modules can be imported directly, for example `@import "@primer/css/core/index.scss";`, `@import "@primer/css/product/index.scss";` or `@import "@primer/css/marketing/index.scss";`. Project status A warning in the README states that the repository is in KTLO ("keep the lights on") mode. The guidance is to keep using the existing utility classes where they are needed, but for more complete patterns that combine styling with markup, the recommendation is to move to primer/react, or, where necessary, primer/view_components. In other words, Primer CSS remains available and supported for its utility classes, while new pattern work is directed to the React and ViewComponents implementations. Development and contribution The repository includes a DEVELOP.md for development documentation, and a RELEASING.md covering the release process for GitHub staff. Continuous integration runs through GitHub Actions, and release metadata is exposed through npm and GitHub badges (package version, build status, contributors, last commit and license). License The project is released under the MIT license, copyright GitHub.