css/modules/primer-page-headers/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

License

MIT © GitHub