primer/css
1
1
Fork 0
mirror of https://github.com/primer/css.git synced 2024-11-28 22:01:43 +03:00
Code Issues Projects Releases Wiki Activity
The CSS design system that powers GitHub
1,465 Commits 41 Branches 271 Tags 64 MiB
SCSS 88.3%
JavaScript 9.6%
Shell 2.1%
080a7979ca
Go to file
Diana Mounter 080a7979ca Publish 
- primer-alerts@1.5.2
 - primer-avatars@1.4.2
 - primer-base@1.6.0
 - primer-blankslate@1.4.2
 - primer-box@2.5.2
 - primer-branch-name@1.0.0
 - primer-breadcrumb@1.4.2
 - primer-buttons@2.5.0
 - primer-core@6.5.0
 - primer-forms@2.0.0
 - primer-labels@1.5.2
 - primer-layout@1.4.2
 - primer-markdown@3.7.2
 - primer-marketing-buttons@1.0.0
 - primer-marketing-support@1.3.2
 - primer-marketing-type@1.4.2
 - primer-marketing-utilities@1.5.0
 - primer-marketing@6.0.0
 - primer-navigation@1.5.0
 - primer-page-headers@1.4.2
 - primer-page-sections@1.4.2
 - primer-popover@0.0.2
 - primer-product@5.5.0
 - primer-subhead@1.0.0
 - primer-support@4.4.2
 - primer-table-object@1.4.2
 - primer-tables@1.4.2
 - primer-tooltips@1.4.2
 - primer-truncate@1.4.2
 - primer-utilities@4.8.2
 - primer@10.0.0
 - generator-primer-module@1.0.1
 - stylelint-config-primer@2.2.1
 - stylelint-selector-no-utility@1.8.1
2017-11-13 19:36:25 -05:00
.github Renaming primer-css to primer 2017-11-09 09:41:18 -08:00
.storybook remove first require context so ordering in nav is more senseible 2017-11-10 16:45:06 -05:00
modules Publish 2017-11-13 19:36:25 -05:00
script Need to output the result 2017-11-10 09:10:38 -08:00
tests abstracting out year regex 2017-10-27 11:28:00 -07:00
tools Publish 2017-11-13 19:36:25 -05:00
.gitignore Updating the changelog style to lerna-changelog output 2017-11-09 16:18:48 -08: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 pull request #396 from primer/new_changelog_style 2017-11-10 08:46:17 -08:00
CHANGELOG.md word this better 2017-11-13 19:18:02 -05:00
lerna.json Changing the changelog repo field 2017-11-10 08:56:42 -08:00
LICENSE Adding a test to check for the current year in the license and source header 2017-10-27 11:25:09 -07:00
package.json Merge pull request #396 from primer/new_changelog_style 2017-11-10 08:46:17 -08:00
README.md Renaming primer-css to primer 2017-11-09 09:41:18 -08: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";

Or, while you're figuring out which modules you need, you can import them directly from the primer packages 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

Documentation

You can read more about primer in the docs.

License

MIT © GitHub