1
1
mirror of https://github.com/primer/css.git synced 2024-11-22 01:53:17 +03:00
The CSS design system that powers GitHub
Go to file
Jon Rohan be518b8023
Updating deprecations.js file to be more straightforward (#1581)
* Updating deprecations.js file to be more straightforward

* Create poor-coins-fix.md

* Remove tests

* Adding more info about the deprecation to the doc

* Title section

* Moving data to deprecations.json

* Moving data to deprecations.json

* Lint only scss files
2021-09-10 10:54:26 -07:00
__tests__ Updating deprecations.js file to be more straightforward (#1581) 2021-09-10 10:54:26 -07:00
.changeset Updating deprecations.js file to be more straightforward (#1581) 2021-09-10 10:54:26 -07:00
.github Update welcome.yml 2021-09-03 09:10:33 -07:00
docs Updating deprecations.js file to be more straightforward (#1581) 2021-09-10 10:54:26 -07:00
script Updating deprecations.js file to be more straightforward (#1581) 2021-09-10 10:54:26 -07:00
src Updating deprecations.js file to be more straightforward (#1581) 2021-09-10 10:54:26 -07: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 (#1568) 2021-09-03 15:24:11 -07:00
CODE_OF_CONDUCT.md Move standard docs to root (#1454) 2021-06-10 12:09:59 +09:00
CONTRIBUTING.md Move standard docs to root (#1454) 2021-06-10 12:09:59 +09: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 Updating deprecations.js file to be more straightforward (#1581) 2021-09-10 10:54:26 -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 Updating stylint config (#1578) 2021-09-07 19:58:09 -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