1
1
mirror of https://github.com/primer/css.git synced 2024-12-25 07:03:35 +03:00
css/packages/primer-marketing-support/README.md
2017-06-23 16:57:00 -04:00

1.7 KiB

Primer CSS Marketing Support

npm version Build Status

Support files are Sass variables, mixins, and functions that we import into different bases for use across components, objects, and utilities. Sharing these common properties across GitHub sites helps us to keep our styles more consistent.

Most of the time to include these you'll only need to add @import "./primer-marketing-support"; to the top of your bundle. If you want only a specific partial you can import them separately.

This repository is a module of the full primer-css repository.

Documentation

Documentation & refactor coming very soon

Install

This repository is distributed with npm. After installing npm, you can install support with this command.

$ npm install --save support

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-marketing-support/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.

License

MIT © GitHub