primer/css
1
1
Fork 0
mirror of https://github.com/primer/css.git synced 2024-11-28 04:43:05 +03:00
Code Issues Projects Releases Wiki Activity
The CSS design system that powers GitHub
1,224 Commits 41 Branches 271 Tags 64 MiB
SCSS 88.3%
JavaScript 9.6%
Shell 2.1%
711c1d5c6c
Go to file
Jon Rohan 711c1d5c6c Publish 
- primer-alerts@1.5.1
 - primer-avatars@1.4.1
 - primer-base@1.5.1
 - primer-blankslate@1.4.1
 - primer-box@2.5.1
 - primer-breadcrumb@1.4.1
 - primer-buttons@2.4.1
 - primer-cards@0.5.1
 - primer-core@6.4.1
 - primer-css@9.6.0
 - primer-forms@1.4.1
 - primer-labels@1.5.1
 - primer-layout@1.4.1
 - primer-markdown@3.7.1
 - primer-marketing-support@1.3.1
 - primer-marketing-type@1.4.1
 - primer-marketing-utilities@1.4.1
 - primer-marketing@5.4.1
 - primer-navigation@1.4.1
 - primer-page-headers@1.4.1
 - primer-page-sections@1.4.1
 - primer-product@5.4.1
 - primer-support@4.4.1
 - primer-table-object@1.4.1
 - primer-tables@1.4.1
 - primer-tooltips@1.4.1
 - primer-truncate@1.4.1
 - primer-utilities@4.8.1
 - generator-primer-module@1.0.0
 - stylelint-config-primer@2.2.0
 - stylelint-selector-no-utility@1.8.0
2017-10-24 14:56:03 -07:00
.github Add unicode arrows, /cc instead of 👀 2017-08-18 15:42:32 -07:00
.storybook Fixing octicons stories 2017-10-24 11:05:55 -07:00
modules Publish 2017-10-24 14:56:03 -07:00
script Using status here 2017-10-23 14:24:41 -07:00
tests/modules read file sync utf8 2017-07-26 11:30:00 -07:00
tools Publish 2017-10-24 14:56:03 -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 Removing primer-dropdown from 9.6.0 release punting to 10 2017-10-24 12:24:07 -07:00
lerna.json update lerna.json 2017-10-11 15:51:51 -07:00
LICENSE Updating to mirror modules 2016-05-25 14:56:43 -04:00
package.json Merge branch 'release-9.6.0' into better-rc 2017-10-17 10:32:43 -07:00
README.md Merge branch 'master' into shawnbot/sass-verbiage 2017-07-11 10:57:57 -07:00

README.md

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