This repository has been archived on 2020-05-08. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
obenland a1b163e8ea Merge branch 'master' of https://github.com/Automattic/_s.git 2013-02-27 13:36:08 -08:00
inc Remove colon from @package DocBlock 2013-02-25 01:15:14 -06:00
js Merge pull request #66 from kovshenin/patch-8 2013-02-27 13:28:31 -08:00
languages Rename translations to languages, see #73 and #50 2012-09-17 12:07:40 +04:00
layouts _s: Update layouts to use classes when appropriate. Fixes #55. 2013-02-27 13:35:28 -08:00
404.php Change apos back to the correct rsquo. See #84. 2013-02-12 16:48:51 -06:00
README.md Remove reference to theme options include in readme.md. 2013-01-27 22:25:31 -06:00
archive.php Escape the return value of get_author_posts_url() with esc_url(). 2013-02-06 20:48:04 -08:00
comments.php Updated 'comments callback' location comment 2013-02-12 10:40:31 -06:00
content-page.php Taking 'Edit' link outside .entry-content 2013-01-30 13:37:52 +05:30
content-single.php Fix tag list separator i18n in content-single.php 2012-11-13 15:08:42 +09:00
content.php Change .tag-links to .tags-links 2012-10-24 11:06:42 -03:00
footer.php Update the HTML "class" system 2012-08-25 14:06:33 -03:00
functions.php Merge pull request #66 from kovshenin/patch-8 2013-02-27 13:28:31 -08:00
header.php Merge pull request #66 from kovshenin/patch-8 2013-02-27 13:28:31 -08:00
image.php Remove debugging code from image.php 2012-12-31 16:59:42 -08:00
index.php Remove current_user_can() check from index.php. A similar conditional now exists in no-results.php. 2012-10-06 16:27:56 -07:00
license.txt _s: initial fork of Toolbox 2012-01-07 03:25:13 +00:00
no-results.php Escape the return value of admin_url() with esc_url() 2013-02-06 20:43:42 -08:00
page.php Update the HTML "class" system 2012-08-25 14:06:33 -03:00
rtl.css _s: initial fork of Toolbox 2012-01-07 03:25:13 +00:00
screenshot.png _s: Adding a blank screenshot 2012-02-08 20:49:01 +00:00
search.php Update the HTML "class" system 2012-08-25 14:06:33 -03:00
searchform.php Change the search form text input to search type and add the basic style for it 2013-02-27 20:26:16 +00:00
sidebar.php _s: This should have been an li element all along 2012-02-03 19:54:30 +00:00
single.php Update the HTML "class" system 2012-08-25 14:06:33 -03:00
style.css Merge branch 'master' of https://github.com/Automattic/_s.git 2013-02-27 13:36:08 -08:00

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.php that can be activated by uncommenting one line in functions.php and adding the code snippet found the comments of inc/custom-header.php to your header.php template.
  • Custom template tags in inc/template-tags that keep your templates clean and neat and prevent code duplication.
  • Some small tweaks in /inc/tweaks.php that can improve your theming experience. They can be activated by uncommenting one line in functions.php.
  • Keyboard navigation for image attachment templates. The script can be found in js/keyboard-navigation.js. Its enqueued in functions.php.
  • A script at js/small-menu.js that makes your menu a toggled dropdown on small screens (like your phone), ready for CSS artistry. Its enqueued in functions.php.
  • 5 sample CSS layouts in /layouts: Two sidebars on the left, two sidebars on the right, a sidebar on either side of your content, and two-column layouts with sidebars on either side.
  • Smartly organized starter CSS in style.css that will help you to quickly get your design off the ground.
  • The GPL license in license.txt. :) 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 — then you'll need to do a three-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 _s with a space before it to replace all the occurrences of it in comments. (You'd replace this with the capitalized version of your theme name.)

OR

  • Search for: '_s' & replace with: 'megatherium'
  • Search for: _s_ & replace with: megatherium_
  • Search for:  _s & 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!