Create Tailwind CSS plugin and publish on npm with ease
tailwindcss-plugin-demo is generated with create-tailwind-plugin
- Tests with Jest
- ESLint config with
airbnb-base
andprettier
- Format code with Prettier
- Pre-commit hooks with husky
- Automatic tests with Github Actions
- Automatic versioning with standard-version
$ npx create-tailwind-plugin
Alternatively, you can also pass following options to avoid prompt questions.
$ npx create-tailwind-plugin --name="Your Plugin Name" --description="Your Plugin Description" --author="Your Name" --github-username="Your Github Username" --initialize-git --install-packages
Option | Description |
---|---|
--name |
Used in README.md and in package.json as name key |
--description |
Used in README.md and in package.json as description key |
--author |
Used in LICENSE and in package.json as author key |
--github-username |
Used in package.json in repository.url , bugs.url , and homepage keys |
--initialize-git |
Runs git init && git add --all command in plugin directory |
--install-packages |
Runs npm install && npm run format --silent command in plugin directory |
- Run
npm install
andnpm run watch
commands in your plugin directory - Update README.md, index.js and test.js files to match your plugin needs
- Run
npm run release
command, when you're ready to publish on npm - Learn more about Tailwind CSS plugins in docs
Feel free to open an issue, if you are having a trouble with create-tailwind-plugin
. PR's are welcome.
Create Tailwind CSS Plugin is licensed under the MIT License.