An open API service indexing awesome lists of open source software.

https://github.com/hex22a/postcss-glitch

PostCSS plugin that adds a glitch effect to your text
https://github.com/hex22a/postcss-glitch

glitch postcss postcss-glitch postcss-plugin

Last synced: about 1 month ago
JSON representation

PostCSS plugin that adds a glitch effect to your text

Awesome Lists containing this project

README

          

# postcss-glitch

Glitch effect implemented with PostCSS. With this plugin you can add a glitch effect to any text!

![animation](http://g.recordit.co/COmXbvzGfg.gif)

Check out [demo page](https://hex22a.github.io/postcss-glitch/) ([source](https://github.com/crftd/postcss-glitch-demos))

---

This is a monorepo for a PostCSS Glitch project.
It contains both plugin source code and various demo projects that use the plugin.

## Working with the repo

> **NOTE:** The following documentation describes how to work with this repo.
> You can find plugin documentation [here](postcss-glitch/README.md).
>
> Also, take a look at the [demos](demos) directory if you are looking for working examples of how to use postcss-glitch plugin.

### Pre-requirements

It's recommended to use [nvm](https://github.com/nvm-sh/nvm) to manage Node versions

[NodeJS](https://nodejs.org/)

```bash
nvm install 24 && nvm use 24
```

[pnpm](https://pnpm.io/)

```bash
npm i -g pnpm
```
### Install dependencies

```bash
pnpm install
```

### Workspaces

This project is a monorepo containing multiple projects a.k.a. workspaces.
Workspaces are defined in [pnpm-workspace.yaml](pnpm-workspace.yaml).
Here we have a workspace under [plugin](postcss-glitch) directory, additionally each directory under [demos](demos) is also considered a workspace.

```yaml
packages:
- postcss-glitch
- demos/*
```

This allows, for example, to install all the dependencies at once for both plugin and all the demo projects while running `pnpm install` in the root folder.

You can learn more about managing monorepo with yarn workspaces in the [documentation](https://pnpm.io/workspaces).

### Contributing

If you want to start contributing to this project, please read the [CONTRIBUTING.md](CONTRIBUTING.md).