/wd_s

A starter theme from WebDevStudios.

Primary LanguagePHP

wd_s

buddy pipeline

Hi. I'm a starter theme called wd_s, or wdunderscores. I'm a theme meant for hacking so don't use me as a Parent Theme. Instead, try turning me into the next, most awesome, WordPress theme out there. That's what I'm here for!

I feature some of the web's most proven technologies like: Tailwind, npm, webpack, Sass, and PostCSS. To help you write clean code (that meets WordPress standards), we tap into @wordpress/scripts for linting CSS and JavaScript. Did I mention that I'm also accessible? Yup. I pass both WCAG 2.1AA and Section 508 standards out of the box.

I also support Selective Refresh and Live Preview in the Theme Customizer.

Looking to use some of our custom Gutenberg blocks? It's easy! Add the WDS Blocks plugin for a quick starter including our Accordion and Carousel bloocks.

Looking to use some of our Advanced Custom Fields Gutenberg Blocks? It's also easy! Add the WDS ACF Blocks plugin for a whole set of blocks built with ACF including: Accordion, Carousel, Call To Action, Fifty/Fifty, Hero, Recent Posts, and Related Posts.

WebDevStudios. Your Success is Our Mission.

Getting Started

Prerequisites

Because I compile and bundle assets via npm scripts, basic knowledge of the command line and the following dependencies are required: Node (v12+) and Composer.

Quick Start

If you want to keep it simple, head over to https://wdunderscores.com and generate your wd_s based theme from there. You just input the name of the theme you want to create, click the "Generate" button, and you get your ready-to-awesomize starter theme.

Advanced

If you want to set me up manually:

  1. Download and extract the zip into your wp-content/themes directory and rename wd_s-master to fit your needs.

  2. Find & Replace

You'll need to change all instances of the names: _s.

  • Search for: '_s' and replace with: 'project-name' (inside single quotations) to capture the text domain
  • Search for: _s_ and replace with: project-name_ to capture all the function names
  • Search for: Text Domain: _s and replace with: Text Domain: project-name in style.css
  • Search for (and include the leading space):  _s and replace with:  Project Name (with a space before it) to capture DocBlocks
  • Search for: _s- and replace with: project-name- to capture prefixed handles
  • Search for _s.pot and replace with: project-name.pot to capture translation files
  • Search for _s.test and replace with: project-name.test to match your local development URL
  • Edit the theme information in the header of style.scss to meet your needs

Installation

  1. From the command line, change directories to your new theme directory:
cd /wp-content/themes/your-theme
  1. Install theme dependencies and trigger an initial build:
npm i

NPM Scripts

From the command line, type any of the following to perform an action:

npm run build - Compile and build all assets.

npm run start - Automatically handle changes to CSS, JS, SVGs, and image sprites.

Contributing and Support

Your contributions and support tickets are welcome. Please see our guidelines before submitting a pull request.