1
1
mirror of https://github.com/primer/css.git synced 2024-12-23 22:24:11 +03:00
The CSS design system that powers GitHub
Go to file
2021-04-06 16:31:32 +09:00
__tests__ Fixing eslint 2021-04-01 10:56:12 -07:00
.changeset Merge branch 'main' into btn-active 2021-04-06 16:31:32 +09:00
.github Better workflow naming 2021-04-04 21:35:00 -07:00
docs Add note about disabling stylelint 2021-04-06 10:06:14 +09:00
fonts Add Inter Bold 2019-12-18 20:00:56 +09:00
script remove script 2021-04-02 11:11:43 -07:00
src Merge branch 'main' into btn-active 2021-04-06 16:31:32 +09:00
.gitignore create pretest script 2021-03-31 22:40:51 -07:00
.npmignore Removing storybook 2021-04-01 13:50:48 -07:00
.npmrc don't create package-lock on install 2021-03-31 21:22:41 -07:00
.vercelignore Rename now files to vercel 2021-04-05 20:41:56 -07:00
CHANGELOG.md Version Packages 2021-03-31 01:06:07 +00:00
deprecations.js Adding deprecation warning for browserslist update 2021-04-01 11:04:14 -07:00
LICENSE Updating docs to reflect new release workflow 2021-04-01 13:36:44 -07:00
package.json Merge branch 'main' into btn-active 2021-04-06 16:31:32 +09:00
postcss.config.js Fix PostCSS include path 2020-08-10 10:41:03 -07:00
README.md Updating docs to reflect new release workflow 2021-04-01 13:36:44 -07:00
stylelint.config.js Moving stylelint plugin to script folder 2021-04-01 08:46:29 -07:00
vercel.json Rename now files to vercel 2021-04-05 20:41:56 -07:00
yarn.lock Removing storybook 2021-04-01 13:50:48 -07:00

Primer CSS

The CSS implementation of GitHub's Primer Design System

Documentation

Our documentation site lives at primer.style/css. You'll be able to find detailed documentation on getting started, all of the components, our theme, our principles, and more.

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 included source files are written in Sass using SCSS syntax. 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 directly from the @primer/css package:

@import "@primer/css/core/index.scss";
@import "@primer/css/product/index.scss";
@import "@primer/css/marketing/index.scss";

Development

See DEVELOP.md for development docs.

Releasing (for GitHub staff)

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

License

MIT © GitHub