schlessera/asv3-theme

Theme for the homepage of the MWPD project.

dev-master 2020-08-28 18:46 UTC

Requires

• ext-json: *

Requires (Dev)

• dealerdirect/phpcodesniffer-composer-installer: 0.6.2
• php-parallel-lint/php-parallel-lint: ^1.2
• phpcompatibility/phpcompatibility-wp: 2.1.0
• phpunit/phpunit: ^6
• roave/security-advisories: dev-master
• sirbrillig/phpcs-variable-analysis: 2.8.1
• squizlabs/php_codesniffer: ^3
• szepeviktor/phpstan-wordpress: ^0.6.2
• vimeo/psalm: ^3.2
• wp-coding-standards/wpcs: 2.3.0

MIT

• Alain Schlesser

README

_s

Hi. I'm a starter theme called _s, or underscores, if you like. 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.

My ultra-minimal CSS might make me look like theme tartare but that means less stuff to get in your way when you're designing your awesome theme. Here are some of the other more interesting things you'll find here:

• A just right amount of lean, well-commented, modern, HTML5 templates.
• A helpful 404 template.
• A custom header implementation in inc/custom-header.php just add the code snippet found in the comments of inc/custom-header.php to your header.php template.
• Custom template tags in inc/template-tags.php that keep your templates clean and neat and prevent code duplication.
• Some small tweaks in inc/template-functions.php that can improve your theming experience.
• A script at js/navigation.js that makes your menu a toggled dropdown on small screens (like your phone), ready for CSS artistry. It's enqueued in functions.php.
• 2 sample CSS layouts in layouts/ for a sidebar on either side of your content. Note: .no-sidebar styles are not automatically loaded.
• Smartly organized starter CSS in style.css that will help you to quickly get your design off the ground.
• Full support for WooCommerce plugin integration with hooks in inc/woocommerce.php, styling override woocommerce.css with product gallery features (zoom, swipe, lightbox) enabled.
• Licensed under GPLv2 or later. :) Use it to make something cool.

Getting Started

If you want to keep it simple, head over to https://underscores.me and generate your _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.

If you want to set things up manually, download _s from GitHub. The first thing you want to do is copy the _s directory and change the name to something else (like, say, megatherium-is-awesome), and then you'll need to do a five-step find and replace on the name in all the templates.

1. Search for '_s' (inside single quotations) to capture the text domain.
2. Search for _s_ to capture all the function names.
3. Search for Text Domain: _s in style.css.
4. Search for  _s (with a space before it) to capture DocBlocks.
5. Search for _s- to capture prefixed handles.

OR

1. Search for: '_s' and replace with: 'megatherium-is-awesome'.
2. Search for: _s_ and replace with: megatherium_is_awesome_.
3. Search for: Text Domain: _s and replace with: Text Domain: megatherium-is-awesome in style.css.
4. Search for:  _s and replace with:  Megatherium_is_Awesome.
5. Search for: _s- and replace with: megatherium-is-awesome-.

Then, update the stylesheet header in style.css, the links in footer.php with your own information and rename _s.pot from languages folder to use the theme's slug. Next, update or delete this readme.

Now you're ready to go! The next step is easy to say, but harder to do: make an awesome WordPress theme. :)

Good luck!