1
1
mirror of https://github.com/primer/css.git synced 2024-12-28 08:31:58 +03:00
The CSS design system that powers GitHub
Go to file
broccolini 13fbace70f add package-lock json file for those on npm 5:
I think this is only in this package because it's the only that needed
updating when I ran lerna boostrap
2017-06-10 11:44:10 -04:00
.github contributing guidelines at the route directory only 2017-05-11 16:00:17 -04:00
packages add package-lock json file for those on npm 5: 2017-06-10 11:44:10 -04:00
.gitignore catch all logs 2017-06-04 18:14:17 -04:00
.npmignore Auto building on publish, and including build dir in npm package 2016-06-02 09:39:45 -04:00
.travis.yml upgrade node version 2017-01-18 16:36:26 -05:00
CHANGELOG.md Adding primer-marketing to the build 2016-11-23 15:06:19 -05:00
lerna.json setup lerna 2017-06-04 18:52:52 -04:00
LICENSE Updating to mirror modules 2016-05-25 14:56:43 -04:00
package.json update root package.json 2017-06-09 16:55:29 -04:00
README.md add core packackages list to readme 2017-06-09 18:15:42 -04:00

Primer CSS

NPM version Build Status

Primer is the CSS framework that powers GitHub's front-end design. It's purposefully limited to common components to provide our developers with the most flexibility, and to keep GitHub uniquely GitHubby. It's built with SCSS and available via NPM, so it's easy to include all or part of it within your own project.

Packages

The Primer repo is managed as a monorepo that is composed of many npm packages.

Core Packages

Package Version Status
primer-core npm Build Status
primer-product npm Build Status
primer-marketing npm Build Status

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 source files included are written in Sass (scss) You can simply point your sass include-path at your node_modules directory and import it like this.

@import "primer-css/index.scss";

You can also import specific portions of the module by importing those partials from the /lib/ folder. Make sure you import any requirements along with the modules.

Build

For a compiled css version of this module, a npm script is included that will output a css version to build/build.css The built css file is also included in the npm package.

$ npm run build

Documentation

You can read more about primer in the docs.

License

MIT © GitHub