# pam-css

> PAM is a light, modular and flexible AMCSS library.

Latest version **1.0.0-beta.2** (published 2019-01-13) · BSD-3-Clause-Attribution license · 0 weekly downloads

## Install

```sh
npm install pam-css
pnpm add pam-css
yarn add pam-css
bun add pam-css
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0-beta.2 |
| Published | 2019-01-13 |
| First published | 2019-01-12 |
| Weekly downloads | 0 |
| License | BSD-3-Clause-Attribution |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 2.9 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 11 |
| Author | MRG Gametek |
| Maintainers | ghost-grapefruit, mrgreenadmin, mrsidde, ollhar, siau, simonauner |
| Keywords | css, less, amcss, styling, ui, web |

## Links

- npm: https://www.npmjs.com/package/pam-css
- Repository: https://github.com/mrgreentech/pam
- Homepage: https://mrgreentech.github.io/pam/
- Issues: https://github.com/mrgreentech/pam/issues
- npm.io page: https://npm.io/package/pam-css

## Alternatives

- [style-dictionary](https://npm.io/package/style-dictionary.md) — 2.0M weekly downloads
- [postcss-merge-idents](https://npm.io/package/postcss-merge-idents.md) — 1.7M weekly downloads
- [@fontsource/noto-sans](https://npm.io/package/@fontsource/noto-sans.md) — 93.0K weekly downloads
- [uglifycss](https://npm.io/package/uglifycss.md) — 71.6K weekly downloads
- [mat4-interpolate](https://npm.io/package/mat4-interpolate.md) — 23.3K weekly downloads

## Recent versions

- 1.0.0-beta.2 (latest) — 2019-01-13
- 1.0.0-beta.5 (beta) — 2019-12-10
- 1.0.0-beta.4 — 2019-11-01
- 1.0.0-beta.3 — 2019-05-28
- 1.0.0-beta.1 — 2019-01-12
- 1.0.0-beta.0 — 2019-01-12

## README

# PAM

[![Build Status](https://travis-ci.org/mrgreentech/pam.svg?branch=master)][travis-ci-link]
![](https://img.shields.io/npm/v/pam-css.svg)
![](https://img.shields.io/npm/l/pam-css.svg)
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)

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

[style-guide-link]: https://mrgreentech.github.io/pam/
[travis-ci-link]: https://travis-ci.org/mrgreentech/pam/

## Installation

```bash
$ npm i pam-css
```

[master-download-link]: https://github.com/mrgreentech/pam/archive/master.zip

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

```shell
$ 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][issues-link]. If that does not ring a bell feel free to [create a new issue][create-issue-link].

[issues-link]: https://github.com/mrgreentech/pam/issues/
[create-issue-link]: https://github.com/mrgreentech/pam/issues/new/

## Documentation

Head over to the PAM [style guide][style-guide-link] 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][legendary-grasshopper-link]) is in the making so stay tuned...

For further information about history have a look at the [CHANGELOG][changelog-link].

[legendary-grasshopper-link]: https://github.com/mrgreentech/pam/tree/legendary-grasshopper
[changelog-link]: ./CHANGELOG.md

## License

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

[license-link]: ./LICENSE.md

---
_Source: https://npm.io/package/pam-css · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._