Antoine/carhop__carhop-theme__DEV
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updating readme

Browse Source
This commit is contained in:
Antoine M 2022-09-27 09:10:13 +00:00
parent 0f41d0c054
commit 7b6f57d4f9
1 changed files with 1 additions and 101 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

102
README.MD
View File

@ -1,101 +1 @@
<p><img src="http://tailpress.io/images/tailpress100.svg" width="260" alt="TailPress"></p>
[![GitHub release](https://img.shields.io/github/release/jeffreyvr/tailpress?include_prereleases=&sort=semver)](https://github.com/jeffreyvr/tailpress/releases/)
[![License](https://img.shields.io/badge/License-MIT-blue)](#license)
[![issues - tailpress](https://img.shields.io/github/issues/jeffreyvr/tailpress)](https://github.com/jeffreyvr/tailpress/issues)
# Introduction
TailPress is a minimal boilerplate theme for WordPress using [Tailwind CSS](https://tailwindcss.com/).
## Getting started
### Using the installer
You can get started using the installer (using composer):
```bash
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.
```bash
tailpress new example-theme --name="Example Theme"
```
By default, TailPress uses esbuild and Tailwind's CLI for compiling. Rather use Laravel Mix?
```bash
tailpress new example-theme --compiler="mix"
```
You can also initialize a new Git repository (branch defaults to `main`):
```bash
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
TailPress uses the [Tailwind CLI](https://tailwindcss.com/docs/installation#using-tailwind-cli), [PostCSS](https://postcss.org) and [esbuild](https://esbuild.github.io).
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](https://wordpress.org/support/article/wordpress-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](https://github.com/jeffreyvr/tailpress/tree/0.1.1) 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
* [TailPress website](https://tailpress.io)
* [Screencasts](https://www.youtube.com/playlist?list=PL6GBdOp044SHIOSCZejodwr1HcYsC43wG)
* [Tailwind CSS Documentation](https://tailwindcss.com/docs)
* [Esbuild Documentation](https://esbuild.github.io)
## Contributors
* [Jeffrey van Rossum](https://github.com/jeffreyvr)
* [All contributors](https://github.com/jeffreyvr/tailpress/graphs/contributors)
## License
MIT. Please see the [License File](/LICENSE) for more information.
A custom Startter Theme made by Deligraph based on Tailpress