pam-css

1.0.0-beta.2 • Public • Published

PAM

Build Status Conventional Commits

PAM is a light and modular CSS library. Based and inspired by the Attribute Modules for CSS methodology (AMCSS).

Installation

$ npm i pam-css

Use

To get started use one of the the raw css files (pam.css or pam.min.css) in the dist folder.

LESS

PAM can be integrated in projects that use LESS as preprocessor. Import the main less file (pam.less) in the dist/less folder to your projects main LESS file, and then your good to go.

Build

Prerequisites: Node and npm

$ git clone https://github.com/mrgreentech/pam.git
cd pam
$ npm i
$ npm run build

Commands

  • build: npm run build

    It starts by linting all the less files in the source with stylelint. After that gulp takes over and starts of by cleaning the build folders and copying the less source files to the build folder. Then files are concated and stamped with license banners. Now the less can be parsed to css which result in the pam.css file. The final step is to minify the css and then prepare the styleguide build by copying pam.css to the styleguide folder. Now it's time to build the styleguide and when that's done a file size report is shown in the console.

  • dev: npm run dev

    This is the one to use for local development of PAM and it's kind of a mind bender. It starts of by doing a build, after that it runs browsersync and onchange in parallel. So that when a change in the src folder is done a build is triggered and when the files in the build folder is updated browsersync updates the browser with the changes.

  • dist: npm run dist

    This is straight forward. Runs a build, cleans the dist folder and copies dist files from build folder.

  • test: npm test

    This simply runs a build since it contains all the steps that needs to be working.

  • stylelint:check: stylelint:check

    Check if stylelint and prettier have any conflicts at the moment.

Issues

Found a bug or have a feature request? First search reported and closed issues. If that does not ring a bell feel free to create a new issue.

Documentation

Head over to the PAM style guide for documentation and examples.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -a -m 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request

History

PAM v1 (Legendary grasshopper) is in the making so stay tuned...

For further information about history have a look at the CHANGELOG.

License

This software is free to use under the MRG Gametek AB BSD license. See the license doc for license and copyright information.

Package Sidebar

Install

npm i pam-css

Weekly Downloads

2

Version

1.0.0-beta.2

License

BSD-3-Clause-Attribution

Unpacked Size

3.09 MB

Total Files

217

Last publish

Collaborators

  • mrgreenadmin
  • ollhar