WP Theme Scaffold

Kickstart your next WordPress project with this block theme scaffold.

Includes:

• Full Site Editing / block theme ready out of the box.
• webpack tooling to watch and build assets.
• WordPress Coding Standards integration and linting.
• Basic Composer hook up.
• Peekaboo site header and menu (sticky on scroll up only): CSS and JS. This can easily be removed.

Excludes:

• WordPress core's block patterns - so you can build your own.
• jQuery - 99.99% of the time jQuery is not needed. Plain JavaScript is adequate.

Goals of this project

1. Expedite WordPress theming on new projects.
2. Provide consistent engineering onboarding to match existing WordPress best practices.

Installation

Important Note: this theme currently requires the latest Gutenberg plugin be installed. However, we hope that will no longer be the case once WordPress 5.9 is released (Dec. 2021).

1. cd wp-content/themes
2. mkdir your-theme-name && cd your-theme-name
3. git clone https://github.com/rareview/wp-theme-scaffold.git .
4. Search and replace all instances of WPThemeScaffold, WPTHEMESCAFFOLD
5. npm run setup to install Composer and npm packages
6. npm run dev to watch and get started.

Contributing

We encourage everyone to contribute to making this project better. Please open an Issue, or even better, a Pull Request to contribute. Thanks!