Giter Club home page Giter Club logo

postcss-plugin-boilerplate's Introduction

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 index.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.

  10. Release by calling npx clean-publish (this tool will remove development configs from package.json).

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

  12. Follow @PostCSS to get the latest updates.

postcss-plugin-boilerplate's People

Contributors

ai avatar trysound avatar francoisromain avatar joaocunha avatar jgjp avatar talgautb avatar willbamford avatar samvk avatar hail2u avatar jonathantneal avatar janwirth avatar jamsinclair avatar gldraphael avatar princed avatar xeqlol avatar ben-eb avatar azat-io avatar hudochenkov avatar tofandel avatar varemenos avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.