1
1
mirror of https://github.com/primer/css.git synced 2024-11-25 07:33:41 +03:00
The CSS design system that powers GitHub
Go to file
broccolini 1fb0bea939 Update fade variables from transparentize to rgba color function
This makes the Sass easier to read since the variable name and alpha
value are the same (ish)
2017-06-19 18:57:49 -04:00
.github contributing guidelines at the route directory only 2017-05-11 16:00:17 -04:00
packages Update fade variables from transparentize to rgba color function 2017-06-19 18:57:49 -04:00
.gitignore catch all logs 2017-06-04 18:14:17 -04:00
.npmignore Auto building on publish, and including build dir in npm package 2016-06-02 09:39:45 -04:00
.travis.yml correct package name 2017-06-11 11:17:34 -04:00
CHANGELOG.md Adding primer-marketing to the build 2016-11-23 15:06:19 -05:00
lerna.json setup lerna 2017-06-04 18:52:52 -04:00
LICENSE Updating to mirror modules 2016-05-25 14:56:43 -04:00
package.json match primer description 2017-06-12 11:36:45 -04:00
README.md wording tweaks 2017-06-12 11:57:51 -04:00

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 simply point your sass include-path at your node_modules directory and import it like this.

@import "primer-css/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