tailpress
tailpress copied to clipboard
jeffreyvr
TailPress is a minimal boilerplate theme for WordPress using Tailwind CSS.
Introduction
TailPress is a minimal boilerplate theme for WordPress using Tailwind CSS.
Getting started
Using the installer
You can get started using the installer (using composer):
composer global require jeffreyvanrossum/tailpress-installer
tailpress new example-theme
If you haven't already, make sure to place the ~/.composer/vendor/bin directory in your PATH so the tailpress executable is found when you run the tailpress command in your terminal.
You can optionally set the theme name.
tailpress new example-theme --name="Example Theme"
By default, TailPress uses esbuild and Tailwind's CLI for compiling. Rather use Laravel Mix?
tailpress new example-theme --compiler="mix"
You can also initialize a new Git repository (branch defaults to main):
tailpress new example-theme --name="Example Theme" --git --branch="main"
Once your theme is ready, don't forget to cd into the directory.
You will be asked if you would like to have WordPress installed as well. Keep in mind that you still need a local development environment for PHP and MySQL.
Regular method
- Clone repo
git clone https://github.com/jeffreyvr/tailpress.git && cd tailpress - Run
rm -rf .gitto remove git (orrmdir .gitfor Windows) - Run
npm install - Run
npm run watchto start developing
General
TailPress uses the Tailwind CLI, PostCSS and esbuild.
You will find the editable CSS and Javascript files within the /resources folder.
Before you use your theme in production, make sure you run npm run production.
NPM Scripts
There are several NPM scripts available. You'll find the full list in the package.json file under "scripts". A script is executed through the terminal by running npm run script-name.
| Script | Description |
|---|---|
| production | Creates a production (minified) build of app.js, app.css and editor-style.css. |
| dev | Creates a development build of app.js, app.css and editor-style.css. |
| watch | Runs several watch scripts concurrently. |
| watch-sync | Runs several watch scripts concurrently and starts browser-sync. |
Block editor support
TailPress comes with support for the block editor.
A basic setup for theme.json is included. This also means that you need to at least use WordPress 5.8. If you wan't to support earlier WordPress versions, you can use an older version of TailPress instead.
CSS-classes for alignment (full, wide etc.) are generated automatically. You can opt-out on this by removing the plugin from the tailwind.config.js file.
To make the editing experience within the block editor more in line with the front end styling, a editor-style.css is generated.
Define theme colors and font sizes
Several colors and font sizes are defined from the beginning. You can modify them in theme.json.
Links
Contributors
License
MIT. Please see the License File for more information.
jeffreyvr