1
1
mirror of https://github.com/primer/css.git synced 2024-12-24 22:53:58 +03:00
The CSS design system that powers GitHub
Go to file
simurai 21c5ebc01b
Colors V2 docs (#1603)
* Add v18 migration guide

* Update colors.mdx

* Move theming to support

* Delete color-system.mdx

* Update nav.yml

* Fix color imports in the docs

* Create small-papayas-prove.md

* Update theming.md

* Update colors.mdx

* Replace V1 with V2 classes

* More docs updates
2021-09-17 16:19:50 +00:00
__tests__ Updating deprecations.js file to be more straightforward (#1581) 2021-09-10 10:54:26 -07:00
.changeset Colors V2 docs (#1603) 2021-09-17 16:19:50 +00:00
.github Prepare main to hold code for next major version (#1599) 2021-09-16 18:20:07 -07:00
docs Colors V2 docs (#1603) 2021-09-17 16:19:50 +00:00
script Fixing bundle report size for bundle that doesn't exist 2021-09-16 18:54:24 -07:00
src Colors V2 docs (#1603) 2021-09-17 16:19:50 +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
.node-version Adding node-version back 2021-04-08 10:15:15 -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
.nvmrc nvmrc file 2021-04-08 10:22:55 -07:00
.vercelignore Revert "change names back" 2021-04-11 15:51:18 -07:00
CHANGELOG.md Version Packages (#1593) 2021-09-16 17:00:04 -07: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 Re-Added light & dark colorblind themes (#1601) 2021-09-16 18:39:23 -07:00
postcss.config.cjs Convert package to a ES module (#1528) 2021-08-11 14:10:47 -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 Replacing deprecated variables with color v2 variables (#1575) 2021-09-08 09:27:40 -07:00
vercel.json Revert "change names back" 2021-04-11 15:51:18 -07:00
yarn.lock Re-Added light & dark colorblind themes (#1601) 2021-09-16 18:39: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