# mischiefer

> A free, lightweight, and open-source CSS Framework with inbuilt light and dark themes. Let's cause some mischief!

Latest version **0.2.1** (published 2021-04-14) · ISC license · 0 weekly downloads

## Install

```sh
npm install mischiefer
pnpm add mischiefer
yarn add mischiefer
bun add mischiefer
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2021-04-14 |
| First published | 2021-04-07 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 108.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Fernando Marques & Arthur Borges |
| Maintainers | fernandorpm, arthurborgesdev |
| Keywords | front-end, css, style, framework, light, dark, responsive |

## Links

- npm: https://www.npmjs.com/package/mischiefer
- Repository: https://github.com/fernandorpm/mischiefer
- Homepage: https://github.com/fernandorpm/mischiefer#readme
- Issues: https://github.com/fernandorpm/mischiefer/issues
- npm.io page: https://npm.io/package/mischiefer

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

- 0.2.1 (latest) — 2021-04-14
- 0.2.0 — 2021-04-13
- 0.1.1 — 2021-04-09
- 0.1.0 — 2021-04-07

## README

# Mischiefer
> A free, lightweight, and open-source CSS Framework with inbuilt light and dark themes. Let's cause some mischief!

## Installation
Mischiefer can be imported into your project in different ways, but in most cases, it will follow the regular HTML structure:

Notice that the CSS file is added inside the header, while the JS file is added inside the body (normally in the end).
```html
<!DOCTYPE html>
<html>
  <head>
    <link rel="stylesheet" href="CSS_PATH_HERE">
  </head>

  <body>
    <!-- Your wonderful content here -->
    <script src="JS_PATH_HERE"></script>
  </body>

</html>
```

1. Import the CSS and the JS files into your HTML files, using the [jsdelivr](https://www.jsdelivr.com/) link:
- CSS: `https://cdn.jsdelivr.net/npm/mischiefer@0.2.1/css/mischiefer.min.css`
- JS: `https://cdn.jsdelivr.net/npm/mischiefer@0.2.1/js/mischiefer.min.js`

2. Install the Mischiefer Package through npm:
- `npm i mischiefer`
- Import the files into your HTML files:
- CSS: `node_modules/mischiefer/css/mischiefer.min.css`
- JS: `node_modules/mischiefer/js/mischiefer.min.js`

3. Download the mischiefer files from Github and import them manually to your project:
- Import the files into your HTML files, passing down the directory where you added the CSS and JS files.

4. Use import commands on your main CSS file: 
- `@import 'https://cdn.jsdelivr.net/npm/mischiefer@0.2.1/css/mischiefer.min.css';`

**Important: right now the JS file cannot be imported in the same way as the CSS file. This will be changed in a near future.**

## Usage

For better infomation about usage, please head to the [Documentation](./Documentation.md).

## Issues and Suggestions

Please head to the [Issues Page](../../issues/1) for more information on how to report problems and/or suggest a feature.

## Authors

👤 **Fernando R P Marques**

- GitHub: [@fernandorpm](https://github.com/fernandorpm)
- Twitter: [@rpm_fernando](https://twitter.com/rpm_fernando)
- LinkedIn: [Fernando R P Marques](https://linkedin.com/in/fernandorpm)

👤 **Arthur Borges**

- GitHub: [@arthurborgesdev](https://github.com/arthurborgesdev)
- Twitter: [@arthurmoises](https://twitter.com/arthurmoises)
- LinkedIn: [Arthur Borges](https://www.linkedin.com/in/arthurmoises/)

## 📝 License

This project is [MIT](./LICENSE) licensed.

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