WowPress-Tailwind/README.md

56 lines
2.1 KiB
Markdown

WowPress
========
A custom theme based on \_tw
## Quickstart
### Installation
1. Move this folder to `wp-content/themes` in your local development environment
2. Run `npm install && npm run dev` in this folder
3. Activate this theme in WordPress
### Development
4. Run `npm run watch`
5. Add [Tailwind utility classes](https://tailwindcss.com/docs/utility-first) with abandon
### Deployment
6. Run `npm run bundle`
7. Upload the resulting zip file to your site using the “Upload Theme” button on the “Add Themes” administration page
Or [deploy with the tool of your choice](https://underscoretw.com/docs/deployment/#h-other-deployment-options)!
## Full Documentation
### Fundamentals
* [Installation](https://underscoretw.com/docs/installation/)
Generate your custom theme, install it in WordPress and run your first Tailwind builds
* [Development](https://underscoretw.com/docs/development/)
Watch for changes, build for production and learn more about how _tw, WordPress and Tailwind work together
* [Deployment](https://underscoretw.com/docs/deployment/)
Share your new WordPress theme with the world
* [Troubleshooting](https://underscoretw.com/docs/troubleshooting/)
Find solutions to potential issues and answers to frequently asked questions
### In Depth
* [Using Tailwind Typography](https://underscoretw.com/docs/tailwind-typography/)
Customize front-end and back-end typographic styles
* [JavaScript Bundling with esbuild](https://underscoretw.com/docs/esbuild/)
Install and bundle JavaScript libraries (very quickly)
* [Linting and Code Formatting](https://underscoretw.com/docs/linting-code-formatting/)
Catch bugs and stop thinking about formatting
### Extras
* [On Tailwind and WordPress](https://underscoretw.com/docs/wordpress-tailwind/)
Understand how WordPress and Tailwind work together
* [Managing Styles for Custom Blocks](https://underscoretw.com/docs/custom-blocks/)
Learn strategies for using Tailwind in theme-specific custom blocks
* [Setting Up Browsersync](https://underscoretw.com/docs/browsersync/)
Add live reloads and synchronized cross-device testing to your workflow