Switch branches/tags
Find file History
emplums Publish
 - primer-marketing-buttons@1.0.9
 - primer-marketing@6.2.5
 - primer-popover@0.1.4
 - primer-product@5.6.7
 - primer@10.8.1
Latest commit b67416b Aug 2, 2018
Permalink
..
Failed to load latest commit information.
LICENSE Happy new year Jan 3, 2018
README.md Changing shields.io url to https Nov 15, 2017
index.scss Happy new year Jan 3, 2018
package-lock.json Adding package-lock.json back Jun 13, 2018
package.json Publish Aug 2, 2018

README.md

Primer

npm version Build Status

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.

License

MIT © GitHub