> Card-like containers to group semantically related content together on marketing websites at GitHub.
This repository is a module of the full [primer-css][primer] repository.
## Documentation
<!-- %docs
title: Cards
status: In review
-->
Documentation & refactor coming very soon
<!-- %enddocs -->
## Install
This repository is distributed with [npm][npm]. After [installing npm][install-npm], you can install `primer-cards` with this command.
```
$ npm install --save primer-cards
```
## 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-cards/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`
