wd_s

A starter theme from WebDevStudios. https://wdunderscores.com

Table of Contents

• Introduction
• Getting Started
  • Prerequisites
  • Quick Start
  • Advanced
• Setup
  • Development
• Contributing and Support

Introduction

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.

Not to mention, I use Browsersync so you can watch your project update in real-time while you work.

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 (v16+)
• NPM (v8+)
• 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. Alternatively, you could download a pre-built ZIP

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 to fit your needs.

2. Find & Replace

You'll need to change all instances of the name: wd_s.

• Search for: @package wd_s and replace with: @package project_name to capture the package name
• Update "WebDevStudios\wd_s,wd_s" to: "CompanyName\project_name,project_name" (with double quotes) in phpcs.xml.dist
• Search for: WebDevStudios\wd_s and replace with: CompanyName\project_name to capture the namespaces
• Update "webdevstudios/wd_s" to "companyname/project_name" (with double quotes) in composer.json
• Search for: , 'wd_s' and replace with: , 'project_name' (inside backticks) to capture the text domain
• Update Text Domain: wd_s to: Text Domain: project_name in style.css
• Update "wd_s" to: "project_name" (with double quotes) in phpcs.xml.dist and package.json
• Update 'wd_s' to: 'project_name' (with single quotes) in inc/setup/setup.php
• Search for: wd_s_ and replace with: project_name_ to capture all the function names
• Search for: 'wd_s- and replace with: 'project_name- to capture prefixed handles
• Search for wd_s.pot and replace with: project_name.pot to capture translation files
• Search for wdunderscores.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

Setup

From the command line, change directories to your new theme directory:

cd /wp-content/themes/your-theme

Install theme dependencies and trigger an initial build.

Note: You will need to have Composer and NPM 8 installed first.

npm i --legacy-peer-deps

Development

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

Contributing and Support

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

wd_s is free software, and is released under the terms of the GNU General Public License version 2 or any later version. See LICENSE.md for complete license.