1
1
mirror of https://github.com/primer/css.git synced 2024-12-11 11:16:04 +03:00
The CSS design system that powers GitHub
Go to file
Jon Rohan 87240f8f72
Merge pull request #384 from primer/year_test
Adding a test to check for the current year in the license and source…
2017-10-27 11:47:42 -07:00
.github Added a space between the # and the ( 2017-10-24 21:23:29 -07:00
.storybook Remove react inline svg and import octicons css 2017-10-27 10:05:04 -07:00
modules Adding a test to check for the current year in the license and source header 2017-10-27 11:25:09 -07:00
script Adding a test to check for the current year in the license and source header 2017-10-27 11:25:09 -07:00
tests abstracting out year regex 2017-10-27 11:28:00 -07:00
tools Adding a test to check for the current year in the license and source header 2017-10-27 11:25:09 -07:00
.gitignore ignore package-lock.json for now 2017-10-11 16:56:31 -07:00
.npmignore Auto building on publish, and including build dir in npm package 2016-06-02 09:39:45 -04:00
.stylelintrc.json Moving .stylelintrc.json to root 2017-07-26 15:14:47 -07:00
.travis.yml Merge branch 'dev' into merge-9.4.0-dev 2017-09-21 13:30:13 -07:00
CHANGELOG.md Updating changelog 2017-10-27 10:14:04 -07:00
lerna.json update lerna.json 2017-10-11 15:51:51 -07:00
LICENSE Adding a test to check for the current year in the license and source header 2017-10-27 11:25:09 -07:00
package.json Adding a test to check for the current year in the license and source header 2017-10-27 11:25:09 -07:00
README.md Merge branch 'master' into shawnbot/sass-verbiage 2017-07-11 10:57:57 -07: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). After installing with npm, you can add your project's node_modules directory to your Sass include paths (AKA load paths in Ruby), then 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/modules/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