primer/css

mirror of https://github.com/primer/css.git synced 2024-12-27 16:11:46 +03:00

History

broccolini ddbf3fec18 update build status urls for all packages		2017-06-12 11:37:40 -04:00
..
lib	rename modules to packages for lerna setup	2017-05-11 16:12:29 -04:00
.gitignore	update git ignore so npm logs don't get committed	2017-06-04 18:13:16 -04:00
.npmignore	rename modules to packages for lerna setup	2017-05-11 16:12:29 -04:00
.postcss.json	rename modules to packages for lerna setup	2017-05-11 16:12:29 -04:00
.stylelintrc.json	rename modules to packages for lerna setup	2017-05-11 16:12:29 -04:00
CHANGELOG.md	rename modules to packages for lerna setup	2017-05-11 16:12:29 -04:00
index.scss	rename modules to packages for lerna setup	2017-05-11 16:12:29 -04:00
LICENSE	rename modules to packages for lerna setup	2017-05-11 16:12:29 -04:00
package.json	Publish	2017-06-11 16:10:02 -04:00
README.md	update build status urls for all packages	2017-06-12 11:37:40 -04:00

README.md

Primer Marketing CSS Page Headers

Jumbotrons, heroes, and featured content sections for marketing websites at GitHub.

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 primer-page-headers with this command.

$ npm install --save primer-page-headers

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-page-headers/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

$ npm run build