Skip to content

hex22a/postcss-glitch

Repository files navigation

postcss-glitch

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

NPM Version CI

Check out demo page (source)


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.

Also, take a look at the demos directory if you are looking for working examples of how to use postcss-glitch plugin.

Pre-requirements

It's recommended to use nvm to manage Node versions

NodeJS

nvm install 24 && nvm use 24

pnpm

npm i -g pnpm

Install dependencies

pnpm install

Workspaces

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

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.

Contributing

If you want to start contributing to this project, please read the CONTRIBUTING.md.

Commit messages

This project uses the release-please action. It is extremely sensitive to commit naming. Please follow conventional commits naming convention and avoid any non-ascii characters like backticks (`), apostrophes ('), double quotes ("), etc.

Always scope Your commits with corresponding package-name from release-please-config.json unless You're working on general repo documentation

Examples:

git commit -m "chore(postcss-glitch): update documentation"
git commit -m "chore(simple): update documentation"

About

PostCSS plugin that adds a glitch effect to your text

Topics

Resources

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors