0f0fc32d16
- primer-alerts@1.5.7 - primer-avatars@1.5.4 - primer-base@1.7.2 - primer-blankslate@1.4.7 - primer-box@2.5.7 - primer-branch-name@1.0.5 - primer-breadcrumb@1.5.3 - primer-buttons@2.5.5 - primer-core@6.10.0 - primer-forms@2.1.2 - primer-labels@1.5.7 - primer-layout@1.4.7 - primer-markdown@3.7.7 - primer-marketing-buttons@1.0.6 - primer-marketing-support@1.5.2 - primer-marketing-type@1.4.7 - primer-marketing-utilities@1.6.3 - primer-marketing@6.2.2 - primer-navigation@1.5.5 - primer-page-headers@1.4.7 - primer-page-sections@1.4.7 - primer-pagination@1.0.1 - primer-popover@0.1.1 - primer-product@5.6.4 - primer-subhead@1.0.5 - primer-support@4.5.4 - primer-table-object@1.4.7 - primer-tables@1.4.7 - primer-tooltips@1.5.5 - primer-truncate@1.4.7 - primer-utilities@4.11.0 - primer@10.6.0 - generator-primer-module@1.0.6 - primer-module-build@1.0.3 - stylelint-config-primer@2.2.7 - stylelint-selector-no-utility@1.8.7 |
||
|---|---|---|
| .github | ||
| .storybook | ||
| meta/scoreboard | ||
| modules | ||
| script | ||
| tests | ||
| tools | ||
| .gitignore | ||
| .npmignore | ||
| .npmrc | ||
| .nvmrc | ||
| .stylelintrc.json | ||
| .travis.yml | ||
| CHANGELOG.md | ||
| lerna.json | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| RELEASING.md | ||
Primer
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 |
|
| primer-core |  |
| primer-product |  |
| primer-marketing |  |
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.