https://github.com/kingkool68/wordpress-rh-starter-theme

My preferred WordPress starter theme
https://github.com/kingkool68/wordpress-rh-starter-theme

Last synced: about 2 months ago
JSON representation

My preferred WordPress starter theme

• Host: GitHub
• URL: https://github.com/kingkool68/wordpress-rh-starter-theme
• Owner: kingkool68
• License: mit
• Created: 2023-02-16T03:22:54.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-27T03:43:15.000Z (8 months ago)
• Last Synced: 2024-04-27T04:28:15.403Z (8 months ago)
• Language: PHP
• Size: 1.49 MB
• Stars: 9
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Russell Heimlich's Starter WordPress Theme

## Getting Started

Install Composer dependencies for PHPCS and code linting: `composer install`

Install node dependencies like Gulp: `npm install`

Start Gulp wich will watch for changes and recompile Sass and JavaScript: `npm run start`

## Templating

Rendering markup is handled by passing data to [Twig](https://twig.symfony.com/) templates via [Sprig](https://github.com/kingkool68/sprig). WordPress [escaping functions](https://developer.wordpress.org/themes/theme-security/data-sanitization-escaping/) are available as Twig filters.

## CSS

Sass files get compiled to `rh.min.css` which is heavily optimized for performant delivery. See the `class-rh-scripts-and-styles.php` file for helper methods.

## JavaScript

JavaScript files wil lbe uglified and minified in the `/wp-content/themes/rh/assets/js/` directory. Scripts must end with the extension `.src.js` in order for them to be compiled. Scripts without the `.src.js` suffix will be deleted by the Gulp watch process when they are recompiled. When in production you should call the uglified and minified version. See the `class-rh-scripts-and-styles.php` file for helper methods.

## Styleguide

This theme comes with a styleguide built in to the theme. Visit `/styleguide/` to access the files in the `/styleguide/` directory of the theme. `/styleguide/colors/` corresponds to the `/styleguide/colors.php` in the theme. Be sure to add any components or modules to the styleguide to make quality control easier.