primer-page-headers/README.md

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

# Primer Marketing CSS Page Headers

[![npm version](https://img.shields.io/npm/v/primer-page-headers.svg)](https://www.npmjs.org/package/primer-page-headers)
[![Build Status](https://travis-ci.org/primer/primer.svg?branch=master)](https://travis-ci.org/primer/primer)

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

This repository is a module of the full [primer][primer] repository.

## Documentation

<!-- %docs
title: Page headers
status: Deprecated
-->

**This component will be removed, and the `primer-page-headers` npm package deprecated, in Primer version 11.**

<!-- %enddocs -->


## Install

This repository is distributed with [npm][npm]. After [installing npm][install-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][sass] (`scss`) You can simply point your sass `include-path` at your `node_modules` directory and import it like this.

```scss
@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 &copy; [GitHub](https://github.com/)

[primer]: https://github.com/primer/primer
[primer-support]: https://github.com/primer/primer-support
[support]: https://github.com/primer/primer-support
[docs]: http://primer.github.io/
[npm]: https://www.npmjs.com/
[install-npm]: https://docs.npmjs.com/getting-started/installing-node
[sass]: http://sass-lang.com/