@mozaic-ds/postcss-prepend/README.md

PostCSS plugin that adds content to the beginning of your CSS/SCSS file.

<h1 align="center">
  PostCSS Prepend
</h1>

<p align="center">
  <a href="https://mozaic.adeo.cloud/">
    <img src="https://mozaic.adeo.cloud/images/badge-adeo-design-system.svg"/>
  </a>
</p>

<p align="center">
  PostCSS Prepend is a PostCSS plugin built for Adeo's Design System needs that allows to insert content at the beginning of your CSS/SCSS file.
</p>

## 🎨 Getting started

**ADEO Design System** is a global and collaborative design system that facilitates the designer and developer experience, enabling them to create universal interfaces perfectly aligned with the business strategy of [Adeo](https://www.adeo.com/).

Learn more about the vision and guidelines by visiting the [main documentation website](https://mozaic.adeo.cloud/).

## 📦 Install

To install the `postcss-prepend` in your project, you will need to run the following command using `npm`:

```
npm install --save-dev @mozaic-ds/postcss-prepend
```

If you prefer `Yarn`, use the following command instead:

```
yarn add -D @mozaic-ds/postcss-prepend
```

## 📝 Usage

The `postcss-prepend` plugin is used in the same way as all PostCSS plugins.

Simply import it into your `postcss.config.js` configuration file at the root of your project, and then add it to the `plugins` key in your PostCSS configuration object.

You can then select the content of your choice to be inserted at the beginning of your CSS/SCSS files.

**Example:**

```js
// postcss.config.js
const MozaicCssPrepend = require('@mozaic-ds/postcss-prepend')

const config = {
  plugins: [
    MozaicCssPrepend(`$mozaic-prepend: true;`),
  ]
}

module.exports = config
```

## 📰 Changelog

Releases are managed with **GitHub Releases**, including the changelog for each one.<br/>
Access to the [Changelog](/CHANGELOG.md) to find out about the detailed changes to each release.

## 📣 Stay in touch

- Join the [#mozaic-support](https://app.slack.com/client/T4R6RCZFA/CKQJZL7C4/) channel on **Slack**
- Join our [Workplace group](https://adeo.workplace.com/groups/427492661454646/)

## 🐞 Bugs and feature requests

Have a bug or a feature request?<br/>
Please [open an issue](https://github.com/adeo/postcss-prepend/issues/new/choose) and use the template associated with your request.

## 🧑‍💻 Contributors

**Owners**

**[ADEO Design System Team](https://github.com/orgs/adeo/teams/adeo-design-system)**

**Maintainers**

- **[David Martin](https://github.com/dmartinds)**
- **[Mohamed Mokhtari](https://github.com/mohamedMok)**
- **[Trésor Iloyi](https://github.com/tiloyi)**

## 📄 Licensing

This project is licensed under the **Apache V2** License. See [LICENSE](LICENSE) for more information.