GithubHelp home page GithubHelp logo

gilbertobotaro / wp-tailwindcss-theme-boilerplate Goto Github PK

View Code? Open in Web Editor NEW

This project forked from mishterk/wp-tailwindcss-theme-boilerplate

0.0 0.0 0.0 299 KB

A minimalist boilerplate for WordPress theme development using Tailwind CSS, SCSS, and Laravel Mix.

Home Page: https://philkurth.com.au/articles/wordpress-theme-using-tailwind-css/

PHP 24.36% JavaScript 60.05% CSS 0.61% SCSS 14.99%

wp-tailwindcss-theme-boilerplate's Introduction

A boilerplate for WordPress theme development using TailwindCSS and Laravel Mix.

Getting started:

  1. Clone into an empty theme directory
  2. cd into your new theme directory
  3. Run npm install
  4. Duplicate the local-example.json file to local.json, then replace the proxy value with your local development hostname
    • This will allow you to use live reload/injection while working on your CSS/JS
  5. Run a search & replace across the theme to replace all instances of 'WpTailwindCssThemeBoilerplate' with a PHP namespace specific to your theme/project
  6. Change the theme information in style.css
  7. Activate your theme
  8. Run npm run dev and start coding

Commands

npm run dev

Assets will be compiled and BrowserSync will proxy the dev host allowing you to work while seeing your CSS and JS changes appear on the site as they are recompiled.

npm run webpack

Runs the development build

npm run prod

Runs the product build which includes asset file versioning and Purge CSS

Versioned Assets

Versioned assets will appear in a build directory alongside a manifest file which is used while enqueuing scripts and styles. This saves you the need to adjust version parameters on your assets and makes it possible to remove parameters on asset URLs without losing the ability to force those assets to update in browsers.

Purge CSS

Purge CSS is pretty darn excellent and is used to strip out any CSS that isn't being used during the production build.

It does this by looking through specified template files to work out which CSS selectors have been used. If it can't find a CSS rule being used in the templates, it removes it from the final CSS.

See the paths option in the mix.purgeCss() invocation in webpack.mix.js for the file paths being looked at.

How to tell Purge CSS to ignore things

The easiest way is to delineate your CSS with comments as per the example below. See whitelisting for more options.

/* purgecss start ignore */
h1 {
  color: blue;
}

h3 {
  color: green;
}
/* purgecss end ignore */

wp-tailwindcss-theme-boilerplate's People

Contributors

eckelarsson avatar mishterk 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.