efcac9bbb7
This is based on the recommendation of the theme review team. https://make.wordpress.org/themes/2015/04/29/a-revised-readme/ The goal is for a uniformly structured read file adopted by all theme authors. Having the template ready in _s would speed up the adoption. |
||
|---|---|---|
| inc | ||
| js | ||
| languages | ||
| layouts | ||
| sass | ||
| template-parts | ||
| .travis.yml | ||
| 404.php | ||
| CONTRIBUTING.md | ||
| README.md | ||
| archive.php | ||
| codesniffer.ruleset.xml | ||
| comments.php | ||
| footer.php | ||
| functions.php | ||
| header.php | ||
| index.php | ||
| page.php | ||
| readme.txt | ||
| rtl.css | ||
| screenshot.png | ||
| search.php | ||
| sidebar.php | ||
| single.php | ||
| style.css | ||
README.md
_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 sample custom header implementation in
inc/custom-header.phpthat can be activated by uncommenting one line infunctions.phpand adding the code snippet found in the comments ofinc/custom-header.phpto yourheader.phptemplate. - Custom template tags in
inc/template-tags.phpthat keep your templates clean and neat and prevent code duplication. - Some small tweaks in
inc/extras.phpthat can improve your theming experience. - A script at
js/navigation.jsthat makes your menu a toggled dropdown on small screens (like your phone), ready for CSS artistry. It's enqueued infunctions.php. - 2 sample CSS layouts in
layouts/for a sidebar on either side of your content. - Smartly organized starter CSS in
style.cssthat will help you to quickly get your design off the ground. - Licensed under GPLv2 or later. :) Use it to make something cool.
Getting Started
If you want to keep it simple, head over to http://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), and then you'll need to do a five-step find and replace on the name in all the templates.
- Search for
'_s'(inside single quotations) to capture the text domain. - Search for
_s_to capture all the function names. - Search for
Text Domain: _sin style.css. - Search for
_s(with a space before it) to capture DocBlocks. - Search for
_s-to capture prefixed handles.
OR
- Search for:
'_s'and replace with:'megatherium' - Search for:
_s_and replace with:megatherium_ - Search for:
Text Domain: _sand replace with:Text Domain: megatheriumin style.css. - Search for:
_sand replace with:Megatherium - Search for:
_s-and replace with:megatherium-
Then, update the stylesheet header in style.css and the links in footer.php with your own information. 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!