mirror of
https://github.com/primer/css.git
synced 2024-12-24 22:53:58 +03:00
The CSS design system that powers GitHub
cssdesign-systemdesign-systemsframeworkmetaprimerprimer-csssassstarred-primer-repostarred-repostyleguideui-components
21c5ebc01b
* 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 |
||
---|---|---|
__tests__ | ||
.changeset | ||
.github | ||
docs | ||
script | ||
src | ||
.eslintrc.json | ||
.gitignore | ||
.node-version | ||
.npmignore | ||
.npmrc | ||
.nvmrc | ||
.vercelignore | ||
CHANGELOG.md | ||
CODE_OF_CONDUCT.md | ||
CONTRIBUTING.md | ||
deprecations.js | ||
DEVELOP.md | ||
LICENSE | ||
package.json | ||
postcss.config.cjs | ||
prettier.config.cjs | ||
README.md | ||
RELEASING.md | ||
stylelint.config.cjs | ||
vercel.json | ||
yarn.lock |
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.