Skip to content

Documentation

Custom WordPress themes, now with Tailwind

Get started quickly, and deploy to production sooner than you expect

Quickstart

Installation

  1. Generate your theme
  2. Unzip the theme archive
  3. Move the resulting folder to wp-content/themes in your local development environment
  4. Run npm install && npm run dev in the moved folder
  5. Activate the theme in WordPress

Development

  1. Run npm run watch
  2. Add Tailwind utility classes with abandon

Deployment

  1. Run npm run bundle
  2. Upload the resulting zip file to your site using the “Upload Theme” button on the “Add Themes” administration page

Have more complex deployment requirements? I’ve received reports of successful deployments via GitHub Actions, Envoyer, Deployer and Capistrano. For more details, please see the deployment documentation.

Full Documentation

    Fundamentals

    • Installation
      Generate your custom theme, install it in WordPress and run your first Tailwind builds
    • Development
      Watch for changes, build for production and learn more about how _tw, WordPress and Tailwind work together
    • Deployment
      Share your new WordPress theme with the world
    • Troubleshooting
      Find solutions to potential issues and answers to frequently asked questions

    In Depth

    Extras