1
1
mirror of https://github.com/primer/css.git synced 2024-12-02 07:53:06 +03:00
The CSS design system that powers GitHub
Go to file
Katie Langerman b7fd01d5a1
Deploy Storybook on Pull-Request (#1703)
* add build storybook

* Storybook deployment status (#1704)

* attempt 1

* nested path for storybook

* create duplicate deployment

* Different environment for storybook

* Take care of failure case as well

Co-authored-by: Siddharth Kshetrapal <siddharthkp@github.com>
2021-10-25 16:45:39 -07:00
__tests__ Removing the duplicate deprecation backgrounds (#1663) 2021-10-08 09:20:20 -07:00
.changeset Add more Octicon support (#1694) 2021-10-25 00:49:49 +00:00
.github Deploy Storybook on Pull-Request (#1703) 2021-10-25 16:45:39 -07:00
docs Deploy Storybook on Pull-Request (#1703) 2021-10-25 16:45:39 -07:00
script Fixing docs build (#1634) 2021-10-01 16:22:30 -07:00
src Add more Octicon support (#1694) 2021-10-25 00:49:49 +00:00
.eslintrc.json Convert package to a ES module (#1528) 2021-08-11 14:10:47 -07:00
.gitignore create pretest script 2021-03-31 22:40:51 -07:00
.npmignore ignore vercel.json 2021-04-07 09:10:53 -07:00
.npmrc don't create package-lock on install 2021-03-31 21:22:41 -07:00
.vercelignore Revert "change names back" 2021-04-11 15:51:18 -07:00
CHANGELOG.md Version Packages (#1688) 2021-10-20 19:43:07 +09:00
CODE_OF_CONDUCT.md Move standard docs to root (#1454) 2021-06-10 12:09:59 +09:00
CONTRIBUTING.md Update Breadcrumbs markup to match w3 aria example (#1590) 2021-09-13 14:06:45 -06:00
deprecations.js Updating deprecations.js file to be more straightforward (#1581) 2021-09-10 10:54:26 -07:00
DEVELOP.md Move standard docs to root (#1454) 2021-06-10 12:09:59 +09:00
LICENSE Updating docs to reflect new release workflow 2021-04-01 13:36:44 -07:00
package.json Bump postcss from 8.3.9 to 8.3.11 (#1699) 2021-10-25 09:21:23 -07:00
postcss.config.cjs Fixing docs build (#1634) 2021-10-01 16:22:30 -07:00
prettier.config.cjs Convert package to a ES module (#1528) 2021-08-11 14:10:47 -07:00
README.md Move standard docs to root (#1454) 2021-06-10 12:09:59 +09:00
RELEASING.md Move standard docs to root (#1454) 2021-06-10 12:09:59 +09:00
stylelint.config.cjs Changing to @primer/stylelint-config and upgrading @primer/primitives to 5.0 rc (#1626) 2021-09-30 10:05:25 +09:00
vercel.json Revert "change names back" 2021-04-11 15:51:18 -07:00
yarn.lock Bump postcss from 8.3.9 to 8.3.11 (#1699) 2021-10-25 09:21:23 -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