1.0.0 • Published 7 years ago

primary.css v1.0.0

Weekly downloads
3
License
MIT
Repository
github
Last release
7 years ago

Primary.css

A Superclean, Minimal, Sass-based CSS Framework.

Table of Contents

Introduction

Primary.css provides a robust CSS foundation of HTML typography, forms, and elements that are easy to customise and style.

Installation

There are several ways of installing the awesome that is primary.css:

Install manually

Download the compiled and minified Primary CSS file. And include primary.css located in /css in your website or Web app <head> part.

<link rel="stylesheet" href="primary.min.css" />`

Install from CDN

Alternatively, you can use the unpkg CDN to load compiled primary.css.

<link rel="stylesheet" href="https://unpkg.com/primary.css@1.0.0/css/primary.min.css" crossorigin="anonymous">

Install with NPM

Install primary.css for your Node powered apps with the npm package:

npm install primary.css

Install with Yarn

Install primary.css with yarn:

yarn add primary.css

GitHub

Clone the repo from GitHub download the source CSS, and documentation files.

git clone {{site.repo}}.git

Structure

The file tree for the install looks like this:

├───dist                    // Dist files (git ignored)
│   ├───primary.css
│   └───primary.min.css
├───docs                    // Documentation
│   ├───index.html
│   └─── ...
├───scss                    // Scss source files
│   ├───base/
│   ├───elements/
│   ├───utilities/
│   └───primary.css
├───README.md
├───config.js
├───gulpfile.babel.js
├───Gemfile
└───package.json

Customize Your Build

You can customize your version of primary.css by editing SASS files in /scss directory or removing unneeded components from .scss source files.

Just follow the following steps:

  1. Make sure you have the following tools installed: node, bundler, babel, gulp, sass.

  2. Clone the project:

    git clone {{site.repo}}.git
  3. Install the dependencies:

    bundler install
    npm install

When completed, you’ll be able to run the various commands provided from the command line.

Gulp commands

Task nameDescription
gulp defaultcompiles everything just once.
gulp buildalias to gulp styles.
gulp stylescompile all scss from scss to dist folder.
gulp beautifybeautify your source files in scss folder.
gulp watchwatchs for changes in scss folder and rebuilds parts of the site as necessary.
gulp version:majorMAJOR version when you make incompatible API changes
gulp version:minorMINOR version when you add functionality in a backwards-compatible manner
gulp version:patchPATCH version when you make backwards-compatible bug fixes.
gulp versionalias to version:path.

Browser support

Primary.css uses Autoprefixer to make most styles compatible with earlier browsers. Primary.css is designed for modern browsers. For best compatibility, these browsers are recommended:

  • Chrome (last 4)
  • Microsoft Edge (last 4)
  • Firefox (last 4)
  • Safari (last 4)
  • Opera (last 4)
  • Internet Explorer 10+

License

The code is available under the MIT license.