Skip to content

NyonCode/tailwindcss-plugin-starter-pack

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Tailwind CSS Plugin Starter Pack

This is a starter pack for creating Tailwind CSS plugins. It provides a basic structure and configuration to help you get started with developing your own custom Tailwind CSS plugins.

Features

  • Basic plugin structure
  • Jest for testing
  • Prettier for code formatting
  • npm scripts for common tasks

Installation

To use this starter pack, follow these steps:

  1. Clone this repository:
    git clone https://github.com/NyonCode/tailwindcss-plugin-starter-pack.git
    
  2. Navigate to the project directory:
    cd tailwindcss-plugin-start-pack
    
  3. Install dependencies:
    npm install
    

Usage

  1. Implement your plugin logic in src/index.js.
  2. Add any necessary theme extensions in the theme.extend object.
  3. Write tests for your plugin in the __tests__ directory.
  4. Run tests:
    npm test
    
  5. Format your code:
    npm run format
    

Configuration

  • jest.config.js: Contains Jest configuration for running tests.
  • .prettierrc: (If you have one) Contains Prettier configuration for code formatting.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Support

If you have any questions or need help with using this starter pack, please open an issue in the GitHub repository.

Acknowledgements


Happy coding! 🚀

About

Tailwind CSS Plugin Starter Pack

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published