primer/css

mirror of https://github.com/primer/css.git synced 2024-12-13 16:15:44 +03:00

History

Shawn Allen 760005cc2a nix non-css stuff from package.json template		2017-09-01 17:15:57 -07:00
..
lib	stub out yeoman generator	2017-08-31 22:23:17 -07:00
index.scss	rename lib/module.scss, async	2017-09-01 11:57:00 -07:00
LICENSE	stub out yeoman generator	2017-08-31 22:23:17 -07:00
package.json	nix non-css stuff from package.json template	2017-09-01 17:15:57 -07:00
README.md	stub out yeoman generator	2017-08-31 22:23:17 -07:00

README.md

Primer CSS / <%= title %>

[![npm version](http://img.shields.io/npm/v/<%= module %>.svg)](https://www.npmjs.org/package/<%= module %>)

<%= description %>

This repository is a module of the full primer-css repository.

Install

This repository is distributed with npm. After installing npm, you can install <%= module %> with this command.

$ npm install --save <%= module %>

Usage

<% if (type === "css") { %> 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 "<%= module %>/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. <% } else { %> <%= usage %> <% } %>

Build

<% if (type === "css") { %> For a compiled css version of this module, a npm script is included that will output a css version to build/build.css The built css file is also included in the npm package.

$ npm run build

<% } else { %> <%= build %> <% } %>

Documentation

<%= docs || "Documentation goes here." %>