1
1
mirror of https://github.com/primer/css.git synced 2024-11-14 03:54:54 +03:00
The CSS design system that powers GitHub
Go to file
2017-06-28 17:58:53 -07:00
.github contributing guidelines at the route directory only 2017-05-11 16:00:17 -04:00
packages manually bump primer version 2017-06-28 17:58:53 -07: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 update to latest version of lerna 2017-06-25 12:00:16 -04:00
LICENSE Updating to mirror modules 2016-05-25 14:56:43 -04:00
package.json add useful npm run scripts for lerna 2017-06-25 12:11:41 -04:00
README.md remove "each" from import instructions 2017-06-28 15:38:23 -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). 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