TailPress

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 Laravel Mix for compiling. Rather use Esbuild?

tailpress new example-theme --compiler="esbuild"

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 .git to remove git (or rmdir .git for Windows)
Run npm install
Run npm run watch to start developing

General

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.

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.

Contributors

License

MIT. Please see the License File for more information.

Project Name	Stars	Repos Using This	Packages Using This	Most Recent Commit	Total Releases	Latest Release	Open Issues	License	Language
Sage	12,107	6	3	7 days ago	40	July 19, 2022	13	mit	PHP
WordPress starter theme with Laravel Blade components and templates, Tailwind CSS, and a modern development workflow
Timber	5,209	131	77	11 days ago	115	June 22, 2022	209	mit	PHP
Create WordPress themes with beautiful OOP code and the Twig Template Engine
Typography.js	3,757	2,206	186	4 months ago	79	May 10, 2021	95	mit	JavaScript
A powerful toolkit for building websites with beautiful design
Argon Theme	3,160			2 months ago			120	gpl-3.0	PHP
📖 Argon - 一个轻盈、简洁的 WordPress 主题
Understrap	2,957	81	1	5 days ago	37	November 08, 2021	75	gpl-3.0	CSS
Underscores + Bootstrap = Understrap, the renowned open-source WordPress starter theme.
Sakura	2,947			2 months ago			20	gpl-2.0	PHP
A Wonderful WordPress Theme: 樱花庄的白猫博客主题
Frontity	2,823	6	67	2 months ago	60	July 19, 2022	66	apache-2.0	TypeScript
» Frontity - The React Framework for WordPress
Foundationpress	2,780			4 years ago	35	April 12, 2019	55	mit	PHP
FoundationPress is a WordPress starter theme based on Foundation 6 by Zurb
Kratos	2,713			2 days ago			6	gpl-3.0	PHP
📖 WordPress theme that focus on reading experience
Plugin Update Checker	1,927	63	30	24 days ago	31	July 24, 2022	79	mit	PHP
A custom update checker for WordPress plugins. Useful if you don't want to host your project in the official WP repository, but would still like it to support automatic updates. Despite the name, it also works with themes.

Tailpress