Skip to content

Latest commit

 

History

History
118 lines (97 loc) · 6.89 KB

README.md

File metadata and controls

118 lines (97 loc) · 6.89 KB
Raw

WordPress Theme Development Boilerplate

WordPress Theme Boilerplate with well organised project structure and modern build tools to quickstart your theme development!

built with Gulp license

Features

  • Based on underscores
  • gulp build script that compiles Less, checks for JavaScript errors, optimizes images, and concatenates and minifies files
  • BrowserSync for keeping multiple browsers and devices synchronized while testing, along with injecting updated CSS and JS into your browser while you're developing
  • Bootstrap 3 for a front-end framework

Requirements

Make sure all dependencies have been installed before moving on:

Prerequisite How to check How to install
Node.js >= 4.5 node -v nodejs.org
npm >= 4.0.0 npm -v npm comes pre-installed with node
yarn >= 0.17.8 yarn -V yarn
gulp >= 3.8.10 gulp -v npm install -g gulp

Theme structure

themes/your-theme-name/         # → Root of your theme
├── assets                      # → Front-end assets
│   ├── images/                   # → Theme images
│   ├── scripts/                  # → Theme JS
│   ├── styles/                   # → Theme stylesheets
│   └── src/                      # → Source directory
│   │   ├── scripts/                # → Source scripts
|   │   └── styles/                 # → Source stylesheets
|   |   │   ├── 1-vendor/             # → CSS files from external libraries
|   |   │   ├── 2-util/               # → Less tools and helpers
|   |   │   ├── 3-base/               # → Boilerplate code for the project
|   |   │   ├── 4-layout/             # → Laying out the site or application
|   |   │   ├── 5-components/         # → Small components and widgets
|   |   │   ├── 6-theme/              # → Different themes
|   |   │   ├── 7-custom/             # → Custom styles
|   |   │   └── main.less             # → The main file imports whole code base
├── inc/                        # → Theme PHP
│   ├── custom-header.php         # → Custom Header feature
│   ├── customizer.php            # → Theme Customizer
│   ├── enqueue.php               # → Enqueue theme stylesheets and scripts
│   ├── extras.php                # → Custom functions
│   ├── jetpack.php               # → Jetpack Compatibility File
│   ├── navwalker.php             # → Custom WordPress nav walker class to implement the Bootstrap 3 navigation
│   ├── setup.php                 # → Theme setup functions and definitions
│   └── template-tags.php         # → Custom template tags for this theme
├── languages/                  # → Theme language files
├── templates-parts/            # → Theme templates
│   ├── content-none.php          # → Template part for displaying a message that posts cannot be found
│   ├── content-page.php          # → Template part for displaying page content in page.php
│   ├── content-search.php        # → Template part for displaying results in search pages
│   └── content.php               # → Template part for displaying posts
├── .editorconfig               # → Consistent coding styles between different editors
├── .gitattributes              # → Defining attributes per path
├── .gitignore                  # → Specifies intentionally untracked files to ignore
├── .jscsrc                     # → JavaScript code style linter and formatter
├── .jshintignore               # → Specifies files and path ignored by JSHint
├── .jshintrc                   # → Flags suspicious usage in programs written in JavaScript
├── 404.php                     # → Template for displaying 404 pages
├── README.md                   # → Project description
├── archive.php                 # → Template for displaying archive pages
├── comments.php                # → Template for displaying comments
├── footer.php                  # → Template for displaying the footer
├── functions.php               # → Theme includes
├── gulpfile.js                 # → Gulp tasks runner
├── header.php                  # → Header for our theme
├── index.php                   # → Main template file
├── package.json                # → Node.js dependencies and scripts
├── page.php                    # → Template for displaying all pages
├── rtl.css                     # → Support for language written in a Right To Left
├── screenshot.png              # → Theme screenshot for WP admin
├── search.php                  # → Template for displaying search results pages
├── sidebar.php                 # → Template for sidebar containing the main widget area
├── single.php                  # → Template for displaying all single posts
└── style.css                   # → Theme meta information

Theme installation

Install boilerplate by copying the project into a new folder within your WordPress themes directory and replace your-theme-name with the name of your theme.

Theme development

This project uses Gulp as a build tool and you can use Yarn to manage front-end packages.

Install dependencies

From the command line on your host machine, navigate to the theme directory then run yarn install:

C:\wamp\www\project-name\wp-content\themes\your-theme-name>
yarn install

You now have all the necessary dependencies to run the build process.

Build commands

  • gulp — Compile and optimize the files in your assets directory
  • gulp serve — Start BrowserSync session and compile assets when file changes are made
  • gulp --production — Compile assets for production (no source maps)

Using BrowserSync

To use BrowserSync during gulp serve or gulp watch you need to update projectURL at line #33 of gulpfile.js to reflect your local development hostname.

If your local development URL is https://project-name.dev, update the file to read:

  var projectURL           = 'http://project-name.dev';

Contributing

Contributions are welcome from everyone.