Skip to content
forked from primer/css

The base coat of GitHub. Our internal CSS toolkit and guidelines.

License

Notifications You must be signed in to change notification settings

bkeepers/primer-css

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Primer CSS

npm version Build Status

Primer is the CSS framework that powers GitHub's front-end design. Primer CSS includes 23 packages that are grouped into 3 core meta-packages for easy install. Each package and meta-package is independently versioned and distributed via npm, so it's easy to include all or part of Primer within your own project.

Packages

The Primer CSS repo is managed as a monorepo that is composed of many npm packages.

Core Packages

Package Version
primer-css
Includes all 23 packages
npm
primer-core npm
primer-product npm
primer-marketing npm

Install

This repository is distributed with npm. After installing npm, you can install primer-css with this command.

$ npm install --save primer-css

Usage

The source files included are written in Sass (SCSS). You can point your Sass include-path at your project's node_modules directory and import it like this:

@import "primer-css/index.scss";

You can import individual Primer modules by installing them with npm, for instance:

$ npm install --save primer-navigation

Then, you would import the module with:

@import "primer-navigation/index.scss";

Or, while you're figuring out which modules you need, you can import them directly from the primer-css packages directory like so:

@import "primer-css/packages/primer-navigation/index.css";

Build

For a compiled CSS version of this module, an npm script is included that will output a CSS version to build/build.css. The built CSS file is also included in the npm package.

$ npm run build

Documentation

You can read more about primer in the docs.

License

MIT © GitHub

About

The base coat of GitHub. Our internal CSS toolkit and guidelines.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CSS 100.0%