https://github.com/imranhsayed/tailwind-wordpress-plugin-example

An example WordPress plugin for using Tailwind css in Gutenberg editor with webpack and sass
https://github.com/imranhsayed/tailwind-wordpress-plugin-example

Last synced: 25 days ago
JSON representation

An example WordPress plugin for using Tailwind css in Gutenberg editor with webpack and sass

• Host: GitHub
• URL: https://github.com/imranhsayed/tailwind-wordpress-plugin-example
• Owner: imranhsayed
• Created: 2020-09-15T14:01:22.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-12-31T22:55:29.000Z (11 months ago)
• Last Synced: 2024-10-03T09:24:16.942Z (about 1 month ago)
• Language: JavaScript
• Size: 181 KB
• Stars: 45
• Watchers: 5
• Forks: 17
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Tailwind WordPress Plugin Example

[![Project Status: Active.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

An example WordPress plugin for using Tailwind css in Gutenberg editor with webpack and sass

## Maintainer

| Name                                                   | Github Username |

|--------------------------------------------------------|-----------------|

| [Imran Sayed](mailto:[email protected])       |  @imranhsayed   |

## Assets

Assets folder contains webpack setup and can be used for creating blocks or adding any other custom scripts like javascript for admin.

- Run `npm i` from `assets` folder to install required npm packages.

- Use `npm run dev` during development for assets.

- Use `npm run build` for production.

- Use `npm run eslint:fix js/fileName.js` for fixing and linting eslint errors and warning.

## Getting Started :clipboard:

These instructions will get you a copy of the project up and running on your local machine for development purposes.

## Installation :wrench:

1. Clone the plugin directory in the `/wp-content/plugins/` directory, or install a zipped directory of this plugin through the [WordPress plugins](https://wordpress.org/plugins/headless-cms/) screen directly.

2. Activate the plugin through the 'Plugins' screen in WordPress

## Contributing :busts_in_silhouette:

Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.

## Versioning

I use [Git](https://github.com/) for versioning. 

## Author :pencil:

* **[Imran Sayed](https://codeytek.com)**

## License :scroll:

![License: GPL v2](https://img.shields.io/badge/License-GPL%20v2-blue.svg)

- **[GPLv2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)**