1
1
mirror of https://github.com/primer/css.git synced 2024-11-29 06:02:33 +03:00
css/packages/primer-cards/README.md
2017-06-12 11:37:40 -04:00

1.6 KiB

Primer Marketing CSS Cards

NPM version Build Status

Card-like containers to group semantically related content together on 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-cards with this command.

$ npm install --save primer-cards

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-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

$ npm run build

License

MIT © GitHub