https://github.com/rareview/wp-theme-scaffold
Kickstart your next WordPress project with this block theme scaffold.
https://github.com/rareview/wp-theme-scaffold
wordpress wordpress-development wordpress-theme
Last synced: 14 days ago
JSON representation
Kickstart your next WordPress project with this block theme scaffold.
- Host: GitHub
- URL: https://github.com/rareview/wp-theme-scaffold
- Owner: rareview
- Created: 2021-09-09T16:45:58.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-12-06T22:10:25.000Z (over 4 years ago)
- Last Synced: 2023-12-15T19:24:36.696Z (over 2 years ago)
- Topics: wordpress, wordpress-development, wordpress-theme
- Language: HTML
- Homepage:
- Size: 506 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WP Theme Scaffold
Kickstart your next WordPress project with this [block theme](https://developer.wordpress.org/block-editor/how-to-guides/themes/block-theme-overview/) scaffold.
Includes:
* Full Site Editing / block theme ready out of the box.
* [webpack](https://webpack.js.org/) tooling to watch and build assets.
* [WordPress Coding Standards](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/) integration and linting.
* Basic [Composer](https://getcomposer.org/) 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.](https://make.wordpress.org/themes/2021/10/04/the-performance-impact-of-using-jquery-in-wordpress-themes/) 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](https://wordpress.org/plugins/gutenberg/) be installed. However, we hope that will no longer be the case once [WordPress 5.9](https://make.wordpress.org/core/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](https://github.com/rareview/wp-theme-scaffold/issues/new/choose), or even better, a [Pull Request](https://github.com/rareview/wp-theme-scaffold/pulls) to contribute. Thanks!