primer/css

mirror of https://github.com/primer/css.git synced 2024-12-01 04:21:12 +03:00

History

Shawn Allen 215720698f nix per package package-lock.json		2018-11-08 00:05:29 -08:00
..
lib	rename packages directory to modules	2017-06-29 12:49:16 -07:00
.npmignore	rename packages directory to modules	2017-06-29 12:49:16 -07:00
index.scss	add missing semicolon	2018-10-22 14:58:15 -07:00
LICENSE	Happy new year	2018-01-03 15:05:16 -08:00
package.json	Publish	2018-10-22 15:22:57 -07:00
README.md	Changing shields.io url to https	2017-11-15 10:08:26 -08: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 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