Stars: 639
Forks: 139
Pull Requests: 704
Issues: 358
Watchers: 52
Last Updated: 2023-09-14 00:58:40
A starter theme from WebDevStudios.
License: GNU General Public License v2.0
Languages: PHP, CSS, JavaScript, SCSS
A starter theme from WebDevStudios. https://wdunderscores.com
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.
Because I compile and bundle assets via NPM scripts, basic knowledge of the command line and the following dependencies are required:
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
If you want to set me up manually:
Download and extract the zip into your wp-content/themes
directory and rename wd_s
to fit your needs.
Find & Replace
You'll need to change all instances of the name: wd_s
.
@package wd_s
and replace with: @package project_name
to capture the package name"WebDevStudios\wd_s,wd_s"
to: "CompanyName\project_name,project_name"
(with double quotes) in phpcs.xml.distWebDevStudios\wd_s
and replace with: CompanyName\project_name
to capture the namespaces"webdevstudios/wd_s"
to "companyname/project_name"
(with double quotes) in composer.json, 'wd_s'
and replace with: , 'project_name'
(inside backticks) to capture the text domainText Domain: wd_s
to: Text Domain: project_name
in style.css"wd_s"
to: "project_name"
(with double quotes) in phpcs.xml.dist and package.json'wd_s'
to: 'project_name'
(with single quotes) in inc/setup/setup.phpwd_s_
and replace with: project_name_
to capture all the function names'wd_s-
and replace with: 'project_name-
to capture prefixed handleswd_s.pot
and replace with: project_name.pot
to capture translation fileswdunderscores.test
and replace with: project_name.test
to match your local development URLFrom 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
From the command line, type any of the following to perform an action:
Command | Action |
---|---|
npm run watch |
Builds assets and starts Live Reload and Browsersync servers |
npm run start |
Builds assets and starts Live Reload server |
npm run build |
Builds production-ready assets for a deployment |
npm run lint |
Check all CSS, JS, MD, and PHP files for errors |
npm run format |
Fix all CSS, JS, MD, and PHP formatting errors automatically |
npm run report |
Gives detailed information on coding standards violations in PHP code |
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.