TailPress is a minimal boilerplate theme for WordPress using Tailwind CSS.
You can use the TailPress installer, or you can simply clone this repository.
To use installer, you need to install it globally via Composer:
composer global require jeffreyvanrossum/tailpress-installer
Afterwards, you can run:
tailpress new example-theme
If the tailpress command is not found, make sure to place Composer's global vendor bin in your $PATH (see).
Flags you can pass when using the installer:
- Set a theme name
--name="Example Theme" - Initialize a git repository
--git - Set the git branch name
--branch="main"
If you choose to install WordPress through the installer, these flags might be of interest as well:
--dbname, --dbuser, --dbpass and --dbhost.
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.
- 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
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.
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 | Recompiles after changes are made. |
To make the editing experience within the block editor more in line with the front end styling, a editor-style.css is generated.
CSS classes for alignment (full, wide etc.) are located in resources/css/utilities.css.
Several colors and font sizes are defined theme.json and the resulting variables are used in the resources/css/theme.css file.
Make sure to place Composer's global vendor bin directory in your $PATH so the tailpress executable can be found by your system. This directory exists in different locations based on your operating system; however, some common locations include:
- macOS:
$HOME/.composer/vendor/bin - Windows:
%USERPROFILE%\AppData\Roaming\Composer\vendor\bin - GNU / Linux Distributions:
$HOME/.config/composer/vendor/bin or $HOME/.composer/vendor/bin
You could also find the composer's global installation path by running composer global about and looking up from the first line.
MIT. Please see the License File for more information.
![@dependabot[bot]](https://avatars.githubusercontent.com/in/29110?s=64&v=4){kind=small}
