1
1
mirror of https://github.com/primer/css.git synced 2024-11-30 01:04:04 +03:00
The CSS design system that powers GitHub
Go to file
2018-06-19 14:49:15 -07:00
.github Remove useless paragraph 🌮 2018-02-28 22:51:40 +02:00
.storybook simplify h/t @mislav 2018-03-27 10:11:40 -07:00
meta/scoreboard removing package-lock 2018-06-13 16:38:50 -07:00
modules add (visual) test cases for AvatarStack on blue bg 2018-06-19 14:49:15 -07:00
script Merge branch 'dev' into import-primer-module-build 2018-05-09 11:49:13 -07:00
tests refactor docs test: more async, one test per class 2018-05-03 15:15:37 -07:00
tools Adding package-lock.json back 2018-06-13 16:48:56 -07:00
.gitignore Adding package-lock.json back 2018-06-13 16:48:47 -07:00
.npmignore Auto building on publish, and including build dir in npm package 2016-06-02 09:39:45 -04:00
.npmrc always save new dependencies, and use exact version 2018-05-11 10:40:15 -07:00
.nvmrc let's all use Node v8, mmkay? 2018-05-11 10:46:02 -07:00
.stylelintrc.json Moving .stylelintrc.json to root 2017-07-26 15:14:47 -07:00
.travis.yml nix explicit scorecard test from travis script 2018-05-09 12:25:07 -07:00
CHANGELOG.md Changelog 📝 2018-06-13 15:56:31 -07:00
lerna.json Removing meta from lerna 2018-06-13 15:45:02 -07:00
LICENSE Happy new year 2018-01-03 15:05:16 -08:00
package-lock.json Adding package-lock.json back 2018-06-13 16:48:56 -07:00
package.json Versions 2018-06-13 16:59:05 -07:00
README.md add staff only to releasing documentation 2018-05-14 09:54:45 -07:00
RELEASING.md a few more tweaks to releasing docs 2018-05-14 09:58:56 -07:00

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.

Packages

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

Core Packages

Package Version
primer
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 with this command.

$ npm install --save primer

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/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 modules directory like so:

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

Releasing (Staff only)

You can find docs about our release process in RELEASING.md.

Documentation

You can read more about primer in the docs.

License

MIT © GitHub