DavidEngland / postcss-plugin-boilerplate

PostCSS Plugin Boilerplate

PostCSS Plugin Boilerplate

Сreate new PostCSS plugins in a few steps:

1. Clone this repository:

git clone https://github.com/postcss/postcss-plugin-boilerplate.git

2. Execute the wizard script. It will ask you a few questions and fill all files with your data.

node ./postcss-plugin-boilerplate/start

Call it with --yarn argument, if you prefer yarn package manager:

node ./postcss-plugin-boilerplate/start --yarn

Or use --no-install if you want to skip dependencies installation.

3. Your plugin repository will now have a clean Git history. Create the GitHub repository and push your project there.

4. Add your project to Travis CI.

5. Write some code to index.js and tests to test.js.

6. Execute npm test command

7. Add input and output CSS examples to README.md.

8. Add options descriptions if your plugin has them.

9. Fill CHANGELOG.md with initial version and release it to npm.

10. Fork PostCSS, add your plugin to the Plugins list and send a pull request.

11. Follow @PostCSS to get the latest updates.