primer/css

mirror of https://github.com/primer/css.git synced 2025-01-01 18:53:34 +03:00

History

Shawn Allen 78b1857eb7 nix unused execa import		2019-01-08 13:38:38 -08:00
..
scripts	nix unused execa import	2019-01-08 13:38:38 -08:00
index.scss	update year in licenses and source headers to 2019	2019-01-04 10:38:46 -08:00
LICENSE	update year in licenses and source headers to 2019	2019-01-04 10:38:46 -08:00
package.json	Publish	2019-01-07 15:03:45 -08:00
README.md	Changing shields.io url to https	2017-11-15 10:08:26 -08:00

README.md

Primer

Primer is the design system that powers GitHub. Primer 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.

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

Install

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

$ npm install --save primer

Usage

The source files included are written in Sass (scss) You can simply point your sass include-path at your node_modules directory and import it like this.

@import "primer/index.scss";

You can also import specific portions of the module by importing those partials from the /lib/ folder. Make sure you import any requirements along with the modules.

Build

For a compiled CSS version of this module, a 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.