primer/css
1
1
Fork 0
mirror of https://github.com/primer/css.git synced 2025-01-01 18:53:34 +03:00
Code Issues Projects Releases Wiki Activity
The CSS design system that powers GitHub
2,071 Commits 41 Branches 271 Tags 65 MiB
SCSS 88.3%
JavaScript 9.6%
Shell 2.1%
16337b25bb
Go to file
Shawn Allen 16337b25bb Publish 
- primer-alerts@1.5.11
 - primer-avatars@1.5.8
 - primer-base@1.9.0
 - primer-blankslate@1.5.0
 - primer-box@2.5.11
 - primer-branch-name@1.0.9
 - primer-breadcrumb@1.5.7
 - primer-buttons@2.6.2
 - primer-core@6.10.5
 - primer-forms@2.1.6
 - primer-labels@1.5.11
 - primer-layout@1.6.0
 - primer-markdown@3.7.11
 - primer-marketing-buttons@1.0.11
 - primer-marketing-support@1.5.4
 - primer-marketing-type@1.4.11
 - primer-marketing-utilities@1.7.1
 - primer-marketing@6.3.1
 - primer-navigation@1.5.9
 - primer-page-headers@1.5.1
 - primer-page-sections@1.5.1
 - primer-pagination@1.0.5
 - primer-popover@0.1.6
 - primer-product@5.8.0
 - primer-progress@0.1.0
 - primer-subhead@1.0.9
 - primer-support@4.7.0
 - primer-table-object@1.4.11
 - primer-tables@1.5.1
 - primer-tooltips@1.5.9
 - primer-truncate@1.4.11
 - primer-utilities@4.14.0
 - primer@10.10.0
 - generator-primer-module@1.2.0
 - primer-module-build@1.0.7
 - stylelint-config-primer@3.0.0
 - stylelint-selector-no-utility@2.0.0
2018-11-19 10:43:02 -08:00
.github nix release docs in .github/CONTRIBUTING 2018-10-18 15:18:19 -07:00
.storybook fix bad merge 2018-10-17 14:58:35 -07:00
meta/scoreboard removing package-lock 2018-06-13 16:38:50 -07:00
modules Publish 2018-11-19 10:43:02 -08:00
script nix unused script/bump-rc 2018-11-13 15:59:06 -08:00
tests refactor docs test: more async, one test per class 2018-05-03 15:15:37 -07:00
tools Publish 2018-11-19 10:43:02 -08:00
.gitignore add subdir package-lock.json to .gitignore 2018-11-08 09:59:38 -08:00
.npmignore Auto building on publish, and including build dir in npm package 2016-06-02 09:39:45 -04:00
.npmrc kill the package-lock.json files 2018-11-13 15:22:23 -08: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 remove --dry-run flag from script/release-candidate 2018-10-23 21:39:44 -07:00
CHANGELOG.md update changelog 2018-10-23 08:58:12 -07:00
DEVELOP.md update DEVELOP.md with new install guidance 2018-11-08 09:29:25 -08:00
lerna.json bring back generator-primer-module in lerna.json 2018-11-13 15:59:06 -08:00
LICENSE Happy new year 2018-01-03 15:05:16 -08:00
package-lock.json updated readme 2018-11-15 15:42:58 -08:00
package.json remove npx dependency (bundled w/npm) 2018-11-13 15:14:06 -08:00
README.md remove stale "Build" section, link to DEVELOP 2018-10-18 16:49:05 -07:00
RELEASING.md move some missing release docs to RELEASING.md 2018-10-18 15:19:11 -07:00

README.md

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";

Development

See DEVELOP.md for development docs.

Releasing (Staff only)

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

Documentation

Primer CSS documentation is published to the GitHub Style Guide.

License

MIT © GitHub