primer/css

mirror of https://github.com/primer/css.git synced 2024-12-24 22:53:58 +03:00

History

Jon Rohan 4df2cf43f8 Adding a test to check for the current year in the license and source header		2017-10-27 11:25:09 -07:00
..
index.scss	Adding a test to check for the current year in the license and source header	2017-10-27 11:25:09 -07:00
LICENSE	Revert "Merge branch 'dev' into master"	2017-09-20 21:21:19 -07:00
package.json	Removing primer-cards module	2017-10-25 12:07:14 -07:00
README.md	rename packages directory to modules	2017-06-29 12:49:16 -07:00

README.md

Primer marketing

Primer marketing is one of 3 meta-packages that belong to the Primer CSS framework. Primer marketing contains packages that are used on GitHub marketing websites.

This repository is a compilation of several CSS packages. You can break it down into smaller sections using npm.

Install

This repository is distributed with npm. After installing npm, you can install primer-css with this command. You must have npm >=3.0 installed to be able to satisfy the dependency paths

$ npm install --save primer-marketing

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